Skip to content

docs: clarify release instructions in CONTRIBUTING #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tobice merged 1 commit into from
Mar 1, 2024
Merged

docs: clarify release instructions in CONTRIBUTING #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,21 +67,25 @@ so don't forget to describe the changes in the new version there.

Beta release happens automatically after you merge a pull request or add a direct commit to the master branch. Before you do that check the following:

- Make sure that in the [pyproject.toml](https://github.com/apify/apify-sdk-python/blob/master/pyproject.toml) a project version is set to the latest non-published version.
- Describe your changes to the [CHANGELOG.md](https://github.com/apify/apify-sdk-python/blob/master/CHANGELOG.md) in the section with the latest non-published version.
- Make sure that in the [pyproject.toml](./pyproject.toml) a project version is set to the latest non-published version.
- Describe your changes to the [CHANGELOG.md](./CHANGELOG.md) in the section with the latest non-published version.

### Production release checklist

Production release happens after the GitHub release is created. Before you do that check the following:

- Make sure that the beta release with the latest commit is successfully deployed.
- Make sure that all the changes that happened from the last production release are described in the [CHANGELOG.md](https://github.com/apify/apify-sdk-python/blob/master/CHANGELOG.md).
- Make sure [here](https://pypi.org/project/apify-shared/#history) that the beta release with the latest commit is successfully deployed.
- Make sure that all changes that happened from the last production release are described in [CHANGELOG.md](./CHANGELOG.md) (it's okay to skip DX related changes, repo setup etc).
- When drafting a new GitHub release:
- Create a new tag in the format of `v1.2.3` targeting the master branch.
- Fill in the release title in the format of `1.2.3`.
- Copy the changes from the [CHANGELOG.md](https://github.com/apify/apify-sdk-python/blob/master/CHANGELOG.md) and paste them into the release description.
- Copy the changes from the [CHANGELOG.md](./CHANGELOG.md) and paste them into the release description. Make sure that all changes are properly categorized using headlines (`Added`, `Fixed` or `Internal changes`).
- Check the "Set as the latest release" option.

Currently, there is no explicit approval process, so when you are done with the checklist, proceed with the release.

Once released, manually bump the version in `pyproject.toml` ([commit example](https://github.com/apify/apify-shared-python/commit/24a269bcf046df7202a8652ee788ffe9a461e58b)).

## Maintanance

### Removing Support for an outdated Python version
Expand Down