Skip to content

Commit 1a49724

Browse files
authored
Merge pull request #542 from ably/add-release-process-codegen
docs: add unasync codegen step to release process
2 parents cde2f53 + d197ccd commit 1a49724

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,10 @@ The release process must include the following steps:
3838
5. Commit this change: `git add CHANGELOG.md && git commit -m "Update change log."`
3939
6. Push the release branch to GitHub
4040
7. Create a release PR (ensure you include an SDK Team Engineering Lead and the SDK Team Product Manager as reviewers) and gain approvals for it, then merge that to `main`
41-
8. From the `main` branch, run `poetry build && poetry publish` to build and upload this new package to PyPi
42-
9. Create a tag named like `v2.0.1` and push it to GitHub - e.g. `git tag v2.0.1 && git push origin v2.0.1`
43-
10. Create the release on GitHub including populating the release notes
41+
8. Build the synchronous REST client by running `poetry run unasync`
42+
9. From the `main` branch, run `poetry build && poetry publish` to build and upload this new package to PyPi
43+
10. Create a tag named like `v2.0.1` and push it to GitHub - e.g. `git tag v2.0.1 && git push origin v2.0.1`
44+
11. Create the release on GitHub including populating the release notes
4445

4546
We tend to use [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator) to collate the information required for a change log update.
4647
Your mileage may vary, but it seems the most reliable method to invoke the generator is something like:

0 commit comments

Comments
 (0)