Skip to content

Commit 33235c8

Browse files
[python-cdk] readme entry about publishing new versions (#37330)
Co-authored-by: Ella Rohm-Ensing <[email protected]>
1 parent 43ecebb commit 33235c8

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

airbyte-cdk/python/README.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -165,5 +165,23 @@ HTTP requests to `localhost:8113/data` should now return the body defined in the
165165

166166
#### Publishing a new version to PyPi
167167

168-
1. Open a PR
169-
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.
168+
Python CDK has a
169+
[GitHub workflow](https://github.com/airbytehq/airbyte/actions/workflows/publish-cdk-command-manually.yml)
170+
that manages the CDK changelog, making a new release for `airbyte_cdk`, publishing it to PyPI, and then making a commit to update (and subsequently auto-release)
171+
[`source-declarative-m anifest`](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-declarative-manifest)
172+
and Connector Builder (in the platform repository).
173+
174+
> [!Note]: The workflow will handle the `CHANGELOG.md` entry for you. You should
175+
> not add changelog lines in your PRs to the CDK itself.
176+
177+
> [!Warning]: The workflow bumps version on it's own, please don't change the
178+
> CDK version in `pyproject.toml` manually.
179+
180+
1. You only trigger the release workflow once all the PRs that you want to be included are already merged into the `master` branch.
181+
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.
182+
3. When the workflow runs, it will commit a new version directly to master
183+
branch.
184+
4. The workflow will bump the version of `source-declarative-manifest` according to the `release-type` of the CDK, then commit these changes
185+
back to master. The commit to master will kick off a publish of the new version of `source-declarative-manifest`.
186+
5. The workflow will also add a pull request to `airbyte-platform-internal`
187+
repo to bump the dependency in Connector Builder.

0 commit comments

Comments
 (0)