Skip to content

Commit db765dc

Browse files
authored
Add release checklists (#154)
1 parent 7df2ca1 commit db765dc

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
@@ -61,3 +61,22 @@ If there is already a stable version with the same version number as in `pyproje
6161
so don't forget to update the version number before releasing a new version.
6262
The release process also fails when the released version is not described in `CHANGELOG.md`,
6363
so don't forget to describe the changes in the new version there.
64+
65+
### Beta release checklist
66+
67+
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:
68+
69+
- 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.
70+
- 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.
71+
72+
### Production release checklist
73+
74+
Production release happens after the GitHub release is created. Before you do that check the following:
75+
76+
- Make sure that the beta release with the latest commit is successfully deployed.
77+
- 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).
78+
- When drafting a new GitHub release:
79+
- Create a new tag in the format of `v1.2.3` targeting the master branch.
80+
- Fill in the release title in the format of `1.2.3`.
81+
- 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+
- Check the "Set as the latest release" option.

0 commit comments

Comments
 (0)