Skip to content

Commit

Permalink
Merge pull request #562 from ably/improve-release-process-readme
Browse files Browse the repository at this point in the history
Improve release process steps in CONTRIBUTING.md
  • Loading branch information
VeskeR authored Apr 5, 2024
2 parents 7819273 + 9e466a7 commit bf6b9a2
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,10 @@ The release process must include the following steps:
6. Push the release branch to GitHub
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`
8. Build the synchronous REST client by running `poetry run unasync`
9. From the `main` branch, run `poetry build && poetry publish` to build and upload this new package to PyPi
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
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`
11. Create the release on GitHub including populating the release notes
12. Update the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/)) with these changes

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

0 comments on commit bf6b9a2

Please sign in to comment.