Skip to content

Commit d45ddd5

Browse files
committed
update release instructions in RELEASES.md
1 parent 205a7ca commit d45ddd5

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/RELEASES.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,13 @@ _Note:_
2121

2222
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 "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.
24+
1. Navigate to the "Publish CDK" workflow in GitHub Actions.
25+
2. Select your dev branch (or `main`) from the "Use workflow from" dropdown.
26+
3. Leave the version number blank, allowing the CI workflow to pick a version number
27+
using [Dunamai](https://dunamai.readthedocs.io).
28+
4. Select from the other options and click "Run workflow".
29+
5. Monitor the workflow to ensure the process has succeeded. You will see the
30+
version number in the GitHub Actions job output and in GitHub Environments view.
2931

3032
## Understanding and Debugging Builder and SDM Releases
3133

@@ -59,15 +61,15 @@ To manually test changes against a dev image of SDM before committing to a relea
5961

6062
Once the publish pipeline has completed, choose a connector to test. Set the base_image in the connector's metadata to your pre-release version in Dockerhub (make sure to update the SHA as well).
6163
Next, build the pre-release image locally using `airbyte-ci connectors —name=<source> build`.
62-
You can now run connector interfaces against the built image using the pattern`docker run airbyte/<source-name>:dev <spec/check/discover/read>`.
64+
You can now run connector interfaces against the built image using the pattern`docker run airbyte/<source-name>:dev <spec/check/discover/read>`.
6365
The connector's README should include a list of these commands, which can be copy/pasted and run from the connector's directory for quick testing against a local config.
6466
You can also run `airbyte-ci connectors —name=<source> test` to run the CI test suite against the dev image.
6567

6668
#### Pretesting Low-Code Python connectors
6769

6870
Once the publish pipeline has completed, set the version of `airbyte-cdk` in the connector's pyproject.toml file to the pre-release version in PyPI.
69-
Update the lockfile and run connector interfaces via poetry:`poetry run source-<name> spec/check/discover/read`.
70-
You can also run `airbyte-ci connectors —name=<source> test` to run the CI test suite against the dev image.


71+
Update the lockfile and run connector interfaces via poetry:`poetry run source-<name> spec/check/discover/read`.
72+
You can also run `airbyte-ci connectors —name=<source> test` to run the CI test suite against the dev image.
7173

7274
#### Pretesting in Cloud
7375

0 commit comments

Comments
 (0)