Add documentation about workarounds

Recommend opening an issue to check them. See #2075.
longturn · Dec 15, 2023 · c778696 · c778696
1 parent 8416eee
commit c778696
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/docs/Contributing/index.rst b/docs/Contributing/index.rst
@@ -12,6 +12,7 @@ Freeciv21 project.
   pull-request.rst
   eval-pull-request.rst
   release.rst
+  workarounds.rst
   stable-branch.rst
   style-guide.rst
   :maxdepth: 1
diff --git a/docs/Contributing/release.rst b/docs/Contributing/release.rst
@@ -53,6 +53,11 @@ These are the general steps to prepare and finalize a release:
    created PR's.
 #. While inside the ``Release Update of AutoRevision.txt`` PR, the release manager will enable an automatic
    rebase and merge.
+#. The release manager will open an issue titled ``Review workarounds after <version> release`` with the following text:
+
+      We should review the workarounds in the source code and check that they are still needed. Some
+      workarounds are documented here: :doc:`Workarounds`.
+
 #. When all the CI actions are complete, the release manager will make a post in the ``#news-channel`` on the
    Longturn.net Discord server.
 #. The release manager will download the Windows i686 and x86_64 installer packages and use their Microsoft

diff --git a/docs/Contributing/workarounds.rst b/docs/Contributing/workarounds.rst
@@ -0,0 +1,11 @@
+.. SPDX-License-Identifier: GPL-3.0-or-later
+.. SPDX-FileCopyrightText: Louis Moureaux <[email protected]>
+
+Workarounds
+***********
+
+This page lists workarounds in the code. They should be checked from time to
+time and removed once they are no longer needed.
+
+#. The macOS CI installs a fixed Python version to work around a bug in Meson.
+   (``.github/workflows/build.yaml``)