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.14.0.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for airbyte_protocol_models_pdv2-0.14.0.tar.gz
Algorithm Hash digest
SHA256 f97d448158e3d66aa231bd3f1075124579b43098e8bb1312807aa7995fae0ed1
MD5 9f7edc2d02bdbd615cea04b8e68d7053
BLAKE2b-256 4bb87ee08fe7bdb5eb0b9b73c0ddbc89fbcb677fe95f934164f748a70696da2e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_protocol_models_pdv2-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9a3ed7ac20ef22cba6d6221ccf3336965da9f5e8a66295d65112333fb4771ab
MD5 1978ad5f889bd94a26b4ca45ff349388
BLAKE2b-256 a7ec9200c3d5fd96aa1938cd2f69c8fa7d1fa6c62e66d967c5aaa9c7f61af2c3

See more details on using hashes here.

Supported by

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