From 43dc2d22f520105f420c8a151460aab8cee716fe Mon Sep 17 00:00:00 2001 From: Natik Gadzhi Date: Mon, 15 Apr 2024 15:04:50 -0700 Subject: [PATCH 1/3] [python-cdk] readme entry about publishing new versions --- airbyte-cdk/python/README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/airbyte-cdk/python/README.md b/airbyte-cdk/python/README.md index 68fe3ee24ba7f..555107e486fee 100644 --- a/airbyte-cdk/python/README.md +++ b/airbyte-cdk/python/README.md @@ -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. From 55fa22f99c21d140bea9fd7c34abddd99d07c9ab Mon Sep 17 00:00:00 2001 From: Natik Gadzhi Date: Tue, 16 Apr 2024 14:55:13 -0700 Subject: [PATCH 2/3] Update airbyte-cdk/python/README.md Co-authored-by: Ella Rohm-Ensing --- airbyte-cdk/python/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/airbyte-cdk/python/README.md b/airbyte-cdk/python/README.md index 555107e486fee..9d1d9339c709a 100644 --- a/airbyte-cdk/python/README.md +++ b/airbyte-cdk/python/README.md @@ -167,7 +167,7 @@ HTTP requests to `localhost:8113/data` should now return the body defined in the 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 +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) [`source-declarative-m anifest`](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-declarative-manifest) and Connector Builder (in the platform repository). From b1056a9ea18508a7e4b14f4603ab05aa5b9bbff7 Mon Sep 17 00:00:00 2001 From: Natik Gadzhi Date: Tue, 16 Apr 2024 14:55:28 -0700 Subject: [PATCH 3/3] Update airbyte-cdk/python/README.md Co-authored-by: Ella Rohm-Ensing --- airbyte-cdk/python/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/airbyte-cdk/python/README.md b/airbyte-cdk/python/README.md index 9d1d9339c709a..4b5c8d571b9f5 100644 --- a/airbyte-cdk/python/README.md +++ b/airbyte-cdk/python/README.md @@ -181,7 +181,7 @@ and Connector Builder (in the platform repository). 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`. +4. The workflow will bump the version of `source-declarative-manifest` according to the `release-type` of the CDK, then commit these changes + back to master. The commit to master will kick off a publish of the new version of `source-declarative-manifest`. 5. The workflow will also add a pull request to `airbyte-platform-internal` repo to bump the dependency in Connector Builder.