Skip to content

[python-cdk] readme entry about publishing new versions #37330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 16, 2024
Merged

[python-cdk] readme entry about publishing new versions #37330

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43dc2d2
[python-cdk] readme entry about publishing new versions
natikgadzhi Apr 15, 2024
55fa22f
Update airbyte-cdk/python/README.md
natikgadzhi Apr 16, 2024
b1056a9
Update airbyte-cdk/python/README.md
natikgadzhi Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions airbyte-cdk/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,5 +165,23 @@ HTTP requests to `localhost:8113/data` should now return the body defined in the

#### Publishing a new version to PyPi

1. Open a PR
2. Once it is approved and **merged**, an Airbyte member must run the `Publish CDK Manually` workflow from master using `release-type=major|manor|patch` and setting the changelog message.
Python CDK has a
[GitHub workflow](https://github.com/airbytehq/airbyte/actions/workflows/publish-cdk-command-manually.yml)
that manages the CDK changelog, making a new release for `airbyte_cdk`, publishing it to PyPI, and then making a pull request to update
[`source-declarative-m anifest`](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-declarative-manifest)
and Connector Builder (in the platform repository).

> [!Note]: The workflow will handle the `CHANGELOG.md` entry for you. You should
> not add changelog lines in your PRs to the CDK itself.

> [!Warning]: The workflow bumps version on it's own, please don't change the
> CDK version in `pyproject.toml` manually.

1. You only trigger the release workflow once all the PRs that you want to be included are already merged into the `master` branch.
2. The [`Publish CDK Manually`](https://github.com/airbytehq/airbyte/actions/workflows/publish-cdk-command-manually.yml) workflow from master using `release-type=major|manor|patch` and setting the changelog message.
3. When the workflow runs, it will commit a new version directly to master
branch.
4. The workflow will add a new pull request to `airbytehq/airbyte` repository to
bump the `airbyte_cdk` dependency on `source-declarative-manifest`.
5. The workflow will also add a pull request to `airbyte-platform-internal`
repo to bump the dependency in Connector Builder.
Loading