Skip to main content

airbyte-protocol

Declares the Airbyte Protocol.

Key Files

  • airbyte_protocol.yaml - declares the Airbyte Protocol (in JSONSchema)
  • io.airbyte.protocol.models - this package contains various java helpers for working with the protocol.

Pull Requests Titles Must Conform to Conventional Commits Convention

We are leveraging the Release Please Action to manage our version bumping and releasing. This action relies on the use of the conventional commits convention to determine whether to bump major, minor, or patch versions. Since we use squash merging, the only commits we see in our history are the titles of our pull requests. This is why we are following conventional commits for our pull request titling. Your actual commits do not need to follow this convention because they never show up in the git history.

Here is a summary of what Release Please looks for in your pull request title.

The most important prefixes you should have in mind are:

  • fix: which represents bug fixes, and correlates to a SemVer patch.
  • feat: which represents a new feature, and correlates to a SemVer minor.
  • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

Release Please will create a pull request when it believes there is a potential new version to be released. It compiles a change log based on the commit history sinced last release. It updates this PR appropriately everytime a PR is merged. If you desire to release a new version, you would approve and merge this PR.

The PR looks something like this. example-release-please-pr

Releasing A Protocol Version

To release:

  • Create a PR following the conventions stated in the above section.
  • Merge this PR in.
  • If the conventional commit convention is followed, CI will create a bump version PR with release notes and the new version. The new version follows conventional commit semantics.
  • Double check the new version by looking at the .env file.
  • Merge the bump version PR in.
  • On merge to master, CI will detect the version change and publish a Java JAR, a PyPi package and an NPM package. A Github release is also created.

Release Errors

If there is a publishing error on merge to master, the manual publishing workflow is an escape hatch for manually republishing artifacts for a specific version.

Metadata

Release files for airbyte-protocol-models 0.18.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for airbyte-protocol-models 0.18.0
File Size Uploaded
airbyte_protocol_models-0.18.0.tar.gz 13.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for airbyte-protocol-models 0.18.0
File Interpreter ABI Platform
airbyte_protocol_models-0.18.0-py3-none-any.whl Python 3 none any Details

Total release size: 26.4 kB

Release files / airbyte_protocol_models-0.18.0.tar.gz

Download URL airbyte_protocol_models-0.18.0.tar.gz
Size 13.8 kB
Tags Source
SHA-256 checksum
How to use checksums
6dac17d62c33057bd79439b2cb9a355b26149f7ec19fd67655432ff29aeaae3b
BLAKE2b-256 checksum
How to use checksums
2fa247a83e4a68d74be9843bd5c25e13528d0dda6cf71c732e93afb1aa0fea01
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.11

Release files / airbyte_protocol_models-0.18.0-py3-none-any.whl

Download URL airbyte_protocol_models-0.18.0-py3-none-any.whl
Size 12.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
09022ae37731825bbe88ce949e5c8ef0a6d5cbc7a8e422c24b4c2abfbe92479d
BLAKE2b-256 checksum
How to use checksums
4315330f9b70a80f42131bd6bc707b7c272a93e4a9df7f430dc2be72101e121a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.11

Release history Release notifications | RSS feed

1.0.1

2 release files

1.0.0

2 release files

This release

0.18.0 This release

2 release files

0.17.1

2 release files

0.17.0

2 release files

0.16.0

2 release files

0.14.2

2 release files

0.14.1

2 release files

0.13.0

2 release files

0.12.2

2 release files

0.12.1

2 release files

0.11.0

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page