Skip to content

Commit ecc842f

Browse files
authored
Add checklist for upgrading Python version (#13)
1 parent 53a611a commit ecc842f

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
@@ -63,3 +63,39 @@ Production release happens after the GitHub release is created. Before you do th
6363
- Fill in the release title in the format of `1.2.3`.
6464
- 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.
6565
- Check the "Set as the latest release" option.
66+
67+
## Maintanance
68+
69+
### Removing Support for an outdated Python version
70+
71+
- Todo: Fill in once Python 3.8 is deprecated.
72+
73+
### Adding support for a new Python version
74+
75+
1) Firstly, ensure that the package (
76+
[apify-sdk-python](https://github.com/apify/apify-sdk-python),
77+
[apify-client-python](https://github.com/apify/apify-client-python),
78+
[apify-shared-python](https://github.com/apify/apify-shared-python)
79+
) is compatible with the new Python version. Both in our code base and
80+
the dependencies we use. Then, release a new version of the package.
81+
- For inspiration, see the PR
82+
[apify/apify-sdk-python#121](https://github.com/apify/apify-sdk-python/pull/121),
83+
where support for Python 3.12 was added to the Apify Python SDK.
84+
85+
2) Next, build and publish the new versions of Python base Docker images.
86+
- For inspiration, see the PR
87+
[apify/apify-actor-docker#112](https://github.com/apify/apify-actor-docker/pull/112),
88+
where support for Python 3.12 was added.
89+
- Apify base Docker images are built using GitHub Actions, accessible at
90+
[apify/apify-actor-docker/actions](https://github.com/apify/apify-actor-docker/actions).
91+
92+
3) Integrate the new Python version into the CI/CD workflows
93+
of existing Python projects (
94+
[apify-sdk-python](https://github.com/apify/apify-sdk-python),
95+
[apify-client-python](https://github.com/apify/apify-client-python),
96+
[apify-shared-python](https://github.com/apify/apify-shared-python),
97+
[actor-templates](https://github.com/apify/actor-templates)
98+
).
99+
- For inspiration, see the PR
100+
[apify/apify-sdk-python#124](https://github.com/apify/apify-sdk-python/pull/124),
101+
where support for Python 3.12 was added to the CI/CD of the Apify Python SDK.

0 commit comments

Comments
 (0)