Skip to main content

Declares the Airbyte Protocol.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_protocol_models_pdv2-0.16.0.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airbyte_protocol_models_pdv2-0.16.0-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_protocol_models_pdv2-0.16.0.tar.gz.

File metadata

File hashes

Hashes for airbyte_protocol_models_pdv2-0.16.0.tar.gz
Algorithm Hash digest
SHA256 c5b7dc55f5e14c97393d43975992a99ed8c8265d0499c9a028e76f638e4a75d9
MD5 3c0b6999869657d13fcd2debf50548d5
BLAKE2b-256 25ce6addf3c44d7ed557fc8cae8359fa136073790f3df36af20a8f4ed7579de3

See more details on using hashes here.

File details

Details for the file airbyte_protocol_models_pdv2-0.16.0-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_protocol_models_pdv2-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bbdc285daedd110632640367fc7ef88f9dea8ae97cdbbe3738429ff1f4cca45d
MD5 cdd22ce4d69cff2b6d37142dfb994a8c
BLAKE2b-256 3391146dc7a1497c5a5dc54fd8109fc391a7b480721cbfa6e33d4af01c8bbbb4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page