Skip to content

Wrap bumping-releases.rst lines to ~80 chars #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 9, 2025
Merged

Wrap bumping-releases.rst lines to ~80 chars #145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 19 additions & 8 deletions docs/bumping-release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,29 @@
Bumping python-newest to latest Python release
====================================================

NOTE: This doc is out of date and needs rework! The `pull request \#13 <https://github.com/python-docs-translations/transifex-automations/pull/13>`_ is a work in progress that would change some instructions from this guide.
NOTE: This doc is out of date and needs rework! The
`pull request \#13 <https://github.com/python-docs-translations/transifex-automations/pull/13>`_
is a work in progress that would change some instructions from this guide.

This document aims to list the steps required for updating version of the 'Python' project (slug 'python-newest) in python-doc organization in Transifex.
This document aims to list the steps required for updating version of the 'Python'
project (slug 'python-newest) in python-doc organization in Transifex.

1. Back up current translations:

#. Run ``sh scripts/update.sh`` to set up the environment, if not done already;
#. Run ``python3 scripts/getlangs.py`` to get a list of all languages;
#. Change to ``cpython/Doc/locales`` directory; and
#. Run ``tx pull --languages <LANGUAGES>`` to download translations from Transifex, replacing ``<LANGUAGES>`` with the output of step 1.2.
#. Run ``tx pull --languages <LANGUAGES>`` to download translations from Transifex,
replacing ``<LANGUAGES>`` with the output of step 1.2.

2. Post a Python version upgrade announcement

3. (How?) Lock all resources in python-newest for all languages

#. Take note of the last change in timeline and its timestamp: *Python* > *Settings* > *Timeline*.

4. Create a Transifex project with versioned name to receive python-newest's translations, setting it with the following values:
4. Create a Transifex project with versioned name to receive python-newest's
translations, setting it with the following values:

:*Name your project*: Python <version> (e.g. Python 3.10)
:*URL to opensource license*: https://github.com/python/cpython
Expand All @@ -38,19 +43,25 @@ In *General* tab:

In *Workflow* tab, enable the *Translation Memory Fillup* option by checking the checkbox;

NOTE: The *Translation Memory Fillup* option is essential to have a translation in one of the version projects to be populated to this project. This drastically reduces translation effort replicating one contribution to other strings that are exactly the same.
NOTE: The *Translation Memory Fillup* option is essential to have a translation
in one of the version projects to be populated to this project. This drastically
reduces translation effort replicating one contribution to other strings that are
exactly the same.

6. Adjust the `CI workflow <https://github.com/python-docs-translations/transifex-automations/tree/main/.github/workflows>`_ with the new Python version:

#. Set ``PYTHON_NEWEST`` environment variable inside ``env`` to the new Python version
#. Edit ``cpython_version`` inside ``strategy.matrix`` adding the new version to the beginning array

7. Push source strings to python-newest by manually running the CI workflow: Actions_ tab > CI > Run workflow button > "Branch: main" and confirm "Run workflow"
7. Push source strings to python-newest by manually running the CI workflow:
Actions_ tab > CI > Run workflow button > "Branch: main" and confirm "Run workflow"

.. _Actions: https://github.com/python-docs-translations/transifex-automations/actions

8. Unlock translations in python-newest, if locked

9. Double-check resources in python-newest. New resources are named after their pot files (e.g. "3.11.pot"), and they should be renamed to match their slug (e.g. "whatsnew--3_11")
9. Double-check resources in python-newest. New resources are named after their
pot files (e.g. "3.11.pot"), and they should be renamed to match their slug (e.g. "whatsnew--3_11")

10. Announce that the maintenance is over, and that python-newest is now using new Python version
10. Announce that the maintenance is over, and that python-newest is now using
new Python version