Skip to content

Commit b7b6082

Browse files
committed
Merge branch 'augustin/sdm-rootless' of https://github.com/airbytehq/airbyte-python-cdk into augustin/sdm-rootless
2 parents ac03234 + f55586a commit b7b6082

File tree

4 files changed

+13
-208
lines changed

4 files changed

+13
-208
lines changed

.github/workflows/connector-tests.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,10 @@ jobs:
163163
fi
164164
echo -e "\n[Download Job Output](${{steps.upload_job_output.outputs.artifact-url}})" >> $GITHUB_STEP_SUMMARY
165165
if [ "${success}" != "true" ]; then
166-
echo "::error::Test failed for connector '${{ matrix.connector }}' on step '${failed_step}'. Check the logs for more details."
166+
echo "::error::Test failed for connector '${{ matrix.connector }}' on step '${failed_step}'. "
167167
exit 1
168168
fi
169+
echo "See the execution report for details: ${html_report_url}"
169170
echo "success=${success}" >> $GITHUB_OUTPUT
170171
echo "html_report_url=${html_report_url}" >> $GITHUB_OUTPUT
171172

.github/workflows/publish_sdm_connector.yml

Lines changed: 0 additions & 178 deletions
This file was deleted.

.github/workflows/pypi_publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ on:
1414
workflow_dispatch:
1515
inputs:
1616
version:
17-
description: "Version. The version to publish, ie 1.0.0 or 1.0.0-dev1. In most cases, you can leave this blank. If run from a release tag (recommended), the version number will be inferred from the git tag."
17+
description: "Note that this workflow is intended for prereleases. For public-facing stable releases, please use the GitHub Releases workflow instead: https://github.com/airbytehq/airbyte-python-cdk/blob/main/docs/RELEASES.md. If running this workflow from main or from a dev branch, please enter the desired version number here, for instance 1.2.3dev0 or 1.2.3rc1."
1818
required: false
1919
publish_to_pypi:
2020
description: "Publish to PyPI. If true, the workflow will publish to PyPI."
@@ -30,7 +30,7 @@ on:
3030
description: "Update Connector Builder. If true, the workflow will create a PR to bump the CDK version used by Connector Builder."
3131
type: boolean
3232
required: true
33-
default: true
33+
default: false
3434

3535
jobs:
3636
build:

docs/RELEASES.md

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Airbyte Python CDK - Release Management Guide
22

3-
## Publishing stable releases of the CDK
3+
## Publishing stable releases of the CDK and SDM
44

55
A few seconds after any PR is merged to `main` , a release draft will be created or updated on the releases page here: https://github.com/airbytehq/airbyte-python-cdk/releases. Here are the steps to publish a CDK release:
66

@@ -13,34 +13,16 @@ A few seconds after any PR is merged to `main` , a release draft will be created
1313

1414
- *Only maintainers can see release drafts. Non-maintainers will only see published releases.*
1515
- If you create a tag on accident that you need to remove, contact a maintainer to delete the tag and the release.
16-
- You can monitor the PyPi release process here in the GitHub Actions view: https://github.com/airbytehq/airbyte-python-cdk/actions/workflows/pypi_publish.yml
16+
- You can monitor the PyPI release process here in the GitHub Actions view: https://github.com/airbytehq/airbyte-python-cdk/actions/workflows/pypi_publish.yml
1717

1818
- **_[▶️ Loom Walkthrough](https://www.loom.com/share/ceddbbfc625141e382fd41c4f609dc51?sid=78e13ef7-16c8-478a-af47-4978b3ff3fad)_**
1919

20-
## Publishing Pre-Release Versions of the CDK
20+
## Publishing Pre-Release Versions of the CDK and/or SDM (Internal)
2121

22-
Publishing a pre-release version is similar to publishing a stable version. However, instead of using the auto-generated release draft, you’ll create a new release draft.
22+
This process is slightly different from the above, since we don't necessarily want public release notes to be published for internal testing releases. The same underlying workflow will be run, but we'll kick it off directly:
2323

24-
1. Navigate to the releases page: https://github.com/airbytehq/airbyte-python-cdk/releases
25-
2. Click “Draft a new release”.
26-
3. In the tag selector, type the version number of the prerelease you’d like to create and copy-past the same into the Release name box.
27-
- The release should be like `vX.Y.Zsuffix` where `suffix` is something like `dev0`, `dev1` , `alpha0`, `beta1`, etc.
28-
29-
## Publishing new versions of SDM (source-declarative-manifest)
30-
31-
Prereqs:
32-
33-
1. The SDM publish process assumes you have already published the CDK. If you have not already done so, you’ll want to first publish the CDK using the steps above. While this prereq is not technically *required*, it is highly recommended.
34-
35-
Publish steps:
36-
37-
1. Navigate to the GitHub action page here: https://github.com/airbytehq/airbyte-python-cdk/actions/workflows/publish_sdm_connector.yml
38-
2. Click “Run workflow” to start the process of invoking a new manual workflow.
39-
3. Click the drop-down for “Run workflow from” and then select the “tags” tab to browse already-created tags. Select the tag of the published CDK version you want to use for the SDM publish process. Notes:
40-
1. Optionally you can type part of the version number to filter down the list.
41-
2. You can ignore the version prompt box (aka leave blank) when publishing from a release tag. The version will be detected from the git tag.
42-
3. You can optionally click the box for “Dry run” if you want to observe the process before running the real thing. The dry run option will perform all steps *except* for the DockerHub publish step.
43-
4. Without changing any other options, you can click “Run workflow” to run the workflow.
44-
5. Watch the GitHub Action run. If successful, you should see it publish to DockerHub and a URL will appear on the “Summary” view once it has completed.
45-
46-
- **_[▶️ Loom Walkthrough](https://www.loom.com/share/bc8ddffba9384fcfacaf535608360ee1)_**
24+
1. Navigate to the "Packaging and Publishing" workflow in GitHub Actions.
25+
2. Type the version number - including a valid pre-release suffix. Examples: `1.2.3dev0`, `1.2.3rc1`, `1.2.3b0`, etc.
26+
3. Select `main` or your dev branch from the "Use workflow from" dropdown.
27+
4. Select your options and click "Run workflow".
28+
5. Monitor the workflow to ensure the process has succeeded.

0 commit comments

Comments
 (0)