Skip to content

Commit f7f4f6d

Browse files
committed
chore: update CONTRIBUTING.md with revised release process steps
1 parent 9ec513b commit f7f4f6d

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +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. Build the synchronous REST client by running `poetry run unasync`
42-
9. From the `main` branch, run `poetry build && poetry publish` (will require you to have a PyPi API token, see [guide](https://www.digitalocean.com/community/tutorials/how-to-publish-python-packages-to-pypi-using-poetry-on-ubuntu-22-04)) 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
45-
12. Update the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/)) with these changes
41+
8. 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`
42+
9. Create the release on GitHub including populating the release notes
43+
10. Go to the [Release Workflow](https://github.com/ably/ably-python/actions/workflows/release.yml) and ask [ably/team-sdk](https://github.com/orgs/ably/teams/team-sdk) member to approve publishing to the PyPI registry
44+
11. Update the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/)) with these changes
4645

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

0 commit comments

Comments
 (0)