OBS-375: Document how to upgrade to a new Python version.

mozilla-services · Oct 29, 2024 · 1a4cc6c · 1a4cc6c
1 parent 1bb0fb8
commit 1a4cc6c
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -1,3 +1,5 @@
+# NOTE(smarnach): To upgrade Python to a new minor or major version, see
+# https://mozilla-eliot.readthedocs.io/en/latest/dev.html#how-to-upgrade-the-python-version
 FROM --platform=linux/amd64 python:3.11.10-slim-bullseye@sha256:f6a64ef0a5cc14855b15548056a8fc77f4c3526b79883fa6709a8e23f676ac34
 
 ARG userid=10001

diff --git a/docs/dev.rst b/docs/dev.rst
@@ -123,7 +123,7 @@ example::
     bug-nnnnnnn: removed frog from tree class
 
 For multiple bugs fixed within a single pull request, list the bugs out individually. For example::
-   
+
    bug-nnnnnnn, bug-nnnnnnn: removed frog from tree class
 
 Pull request descriptions should cover at least some of the following:
@@ -395,3 +395,16 @@ the container to pick up changes:
 .. code-block:: shell
 
    $ make devcontainer
+
+How to upgrade the Python version
+---------------------------------
+
+To upgrade Python to a new minor or major version, you need to change the version in
+these files:
+
+* ``.devcontainer/Dockerfile``
+* ``.github/dependabot.yml``
+* ``.readthedocs.yaml``
+* ``docker/Dockerfile``
+* ``docker/images/fakesentry/Dockerfile``
+* ``pyproject.toml``