You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,21 +67,25 @@ so don't forget to describe the changes in the new version there.
67
67
68
68
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:
69
69
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.
72
72
73
73
### Production release checklist
74
74
75
75
Production release happens after the GitHub release is created. Before you do that check the following:
76
76
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).
79
79
- When drafting a new GitHub release:
80
80
- Create a new tag in the format of `v1.2.3` targeting the master branch.
81
81
- 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`).
83
83
- Check the "Set as the latest release" option.
84
84
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
+
85
89
## Maintanance
86
90
87
91
### Removing Support for an outdated Python version
0 commit comments