Skip to content

Commit 4c9c72e

Browse files
authored
docs: clarify release instructions in CONTRIBUTING (#181)
1 parent 2bcb70d commit 4c9c72e

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,14 +91,18 @@ Beta release happens automatically after you merge a pull request or add a direc
9191

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

94-
- Make sure that the beta release with the latest commit is successfully deployed.
95-
- 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).
94+
- Make sure [here](https://pypi.org/project/apify-client/#history) that the beta release with the latest commit is successfully deployed.
95+
- 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).
9696
- When drafting a new GitHub release:
9797
- Create a new tag in the format of `v1.2.3` targeting the master branch.
9898
- Fill in the release title in the format of `1.2.3`.
99-
- 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.
99+
- 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`).
100100
- Check the "Set as the latest release" option.
101101

102+
Currently, there is no explicit approval process, so when you are done with the checklist, proceed with the release.
103+
104+
Once released, manually bump the version in `pyproject.toml` ([PR example](https://github.com/apify/apify-client-python/pull/180)).
105+
102106
## Maintanance
103107

104108
### Removing Support for an outdated Python version

0 commit comments

Comments
 (0)