Skip to content

Commit

Permalink
docs: clarify release instructions in CONTRIBUTING (#181)
Browse files Browse the repository at this point in the history
  • Loading branch information
tobice authored Feb 16, 2024
1 parent 2bcb70d commit 4c9c72e
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,18 @@ Beta release happens automatically after you merge a pull request or add a direc

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-client/#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 the [CHANGELOG.md](https://github.com/apify/apify-sdk-python/blob/master/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](https://github.com/apify/apify-sdk-python/blob/master/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` ([PR example](https://github.com/apify/apify-client-python/pull/180)).

## Maintanance

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

0 comments on commit 4c9c72e

Please sign in to comment.