Skip to content

Commit aed74b2

Browse files
authored
Add release checklists (#10)
1 parent 0241ce5 commit aed74b2

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,22 @@ If there is already a stable version with the same version number as in `pyproje
4444
so don't forget to update the version number before releasing a new version.
4545
The release process also fails when the released version is not described in `CHANGELOG.md`,
4646
so don't forget to describe the changes in the new version there.
47+
48+
### Beta release checklist
49+
50+
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:
51+
52+
- 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.
53+
- 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.
54+
55+
### Production release checklist
56+
57+
Production release happens after the GitHub release is created. Before you do that check the following:
58+
59+
- Make sure that the beta release with the latest commit is successfully deployed.
60+
- 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).
61+
- When drafting a new GitHub release:
62+
- Create a new tag in the format of `v1.2.3` targeting the master branch.
63+
- Fill in the release title in the format of `1.2.3`.
64+
- 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.
65+
- Check the "Set as the latest release" option.

0 commit comments

Comments
 (0)