Skip to content

Commit bbe9cbb

Browse files
authoredOct 31, 2023
Add checklist for upgrading Python version (#129)
·
v2.6.0v1.3.0b1
1 parent e59a573 commit bbe9cbb

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed
 

‎CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,39 @@ Production release happens after the GitHub release is created. Before you do th
8080
- Fill in the release title in the format of `1.2.3`.
8181
- 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.
8282
- Check the "Set as the latest release" option.
83+
84+
## Maintanance
85+
86+
### Removing Support for an outdated Python version
87+
88+
- Todo: Fill in once Python 3.8 is deprecated.
89+
90+
### Adding support for a new Python version
91+
92+
1) Firstly, ensure that the package (
93+
[apify-sdk-python](https://github.com/apify/apify-sdk-python),
94+
[apify-client-python](https://github.com/apify/apify-client-python),
95+
[apify-shared-python](https://github.com/apify/apify-shared-python)
96+
) is compatible with the new Python version. Both in our code base and
97+
the dependencies we use. Then, release a new version of the package.
98+
- For inspiration, see the PR
99+
[apify/apify-sdk-python#121](https://github.com/apify/apify-sdk-python/pull/121),
100+
where support for Python 3.12 was added to the Apify Python SDK.
101+
102+
2) Next, build and publish the new versions of Python base Docker images.
103+
- For inspiration, see the PR
104+
[apify/apify-actor-docker#112](https://github.com/apify/apify-actor-docker/pull/112),
105+
where support for Python 3.12 was added.
106+
- Apify base Docker images are built using GitHub Actions, accessible at
107+
[apify/apify-actor-docker/actions](https://github.com/apify/apify-actor-docker/actions).
108+
109+
3) Integrate the new Python version into the CI/CD workflows
110+
of existing Python projects (
111+
[apify-sdk-python](https://github.com/apify/apify-sdk-python),
112+
[apify-client-python](https://github.com/apify/apify-client-python),
113+
[apify-shared-python](https://github.com/apify/apify-shared-python),
114+
[actor-templates](https://github.com/apify/actor-templates)
115+
).
116+
- For inspiration, see the PR
117+
[apify/apify-sdk-python#124](https://github.com/apify/apify-sdk-python/pull/124),
118+
where support for Python 3.12 was added to the CI/CD of the Apify Python SDK.

0 commit comments

Comments
 (0)
Please sign in to comment.