Skip to content

Commit 6e5fd12

Browse files
authored
docs: clarify release instructions in CONTRIBUTING (#20)
Same instructions as in apify/apify-client-python#181
1 parent 076ace5 commit 6e5fd12

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,21 +67,25 @@ so don't forget to describe the changes in the new version there.
6767

6868
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:
6969

70-
- 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.
71-
- 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.
70+
- Make sure that in the [pyproject.toml](./pyproject.toml) a project version is set to the latest non-published version.
71+
- Describe your changes to the [CHANGELOG.md](./CHANGELOG.md) in the section with the latest non-published version.
7272

7373
### Production release checklist
7474

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

77-
- Make sure that the beta release with the latest commit is successfully deployed.
78-
- 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).
77+
- Make sure [here](https://pypi.org/project/apify-shared/#history) that the beta release with the latest commit is successfully deployed.
78+
- 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).
7979
- When drafting a new GitHub release:
8080
- Create a new tag in the format of `v1.2.3` targeting the master branch.
8181
- Fill in the release title in the format of `1.2.3`.
82-
- 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.
82+
- 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`).
8383
- Check the "Set as the latest release" option.
8484

85+
Currently, there is no explicit approval process, so when you are done with the checklist, proceed with the release.
86+
87+
Once released, manually bump the version in `pyproject.toml` ([commit example](https://github.com/apify/apify-shared-python/commit/24a269bcf046df7202a8652ee788ffe9a461e58b)).
88+
8589
## Maintanance
8690

8791
### Removing Support for an outdated Python version

0 commit comments

Comments
 (0)