doc: Add steps for Transifex to release process #22369

pull jonatack wants to merge 2 commits into bitcoin:master from jonatack:update-transifex-release-process changing 2 files +12 −9
  1. jonatack commented at 10:45 AM on June 29, 2021: member

    Document how to update settings on and for the transifex website before and after branch-off of a new release.

    (This is #21440, updated with the review feedback.)

  2. jonatack commented at 10:48 AM on June 29, 2021: member

    Opened as I reckon the PR author has other cats to herd at the moment. To be closed if #21440 is merged, and vice-versa.

  3. fanquake added the label Docs on Jun 29, 2021
  4. jarolrod commented at 7:17 PM on June 29, 2021: member

    ACK 92b8fdf9a1a4c2ae16198e2dfd29678ac6779e9b

    The doc change looks good to me 👍

    The following diff shows that this PR has applied the review suggestions from #21440. Specifically: (1, 2, 3)

    diff --git a/./old/bitcoin/doc/release-process.md b/./new/bitcoin/doc/release-process.md
index c4ba5da..94bd75b 100644
--- a/./old/bitcoin/doc/release-process.md
+++ b/./new/bitcoin/doc/release-process.md
@@ -38,11 +38,11 @@ Release Process
      that causes rejection of blocks in the past history.
 - Clear the release notes and move them to the wiki (see "Write the release notes" below).
 - Translations on Transifex
-    - Create [a new resource](https://www.transifex.com/bitcoin/bitcoin/content/) named after the major version with slug `[bitcoin.qt-translation-<RRR>x]` where `RRR` is the major branch number padded with zeros. Use `src/qt/locale/bitcoin_en.ts` to create it.
+    - Create [a new resource](https://www.transifex.com/bitcoin/bitcoin/content/) named after the major version with the slug `[bitcoin.qt-translation-<RRR>x]`, where `RRR` is the major branch number padded with zeros. Use `src/qt/locale/bitcoin_en.ts` to create it.
     - Copy over the translations of the previous version using [transifex-migrate-resource](https://github.com/bitcoin-core/bitcoin-maintainer-tools#transifex-migrate-resource).
-    - Update the transifex slug in [`.tx/config`](/.tx/config) to the slug of the resource created in first step. This identifies which resource translations will be synchronized from.
+    - Update the Transifex slug in [`.tx/config`](/.tx/config) to the slug of the resource created in the first step. This identifies which resource the translations will be synchronized from.
     - Make an announcement that translators can start translating for the new version. You can use one of the [previous announcements](https://www.transifex.com/bitcoin/bitcoin/announcements/) as a template.
-    - Change the resource auto-update URL for the resource to `master`, e.g. `https://raw.githubusercontent.com/bitcoin/bitcoin/<branch>/src/qt/locale/bitcoin_en.ts`. (Do this only after the previous steps to prevent an auto-update from interfering.
+    - Change the auto-update URL for the resource to `master`, e.g. `https://raw.githubusercontent.com/bitcoin/bitcoin/master/src/qt/locale/bitcoin_en.ts`. (Do this only after the previous steps, to prevent an auto-update from interfering.)
 
 #### After branch-off (on master)
 
@@ -53,7 +53,7 @@ Release Process
 - Update the versions.
 - Create a pinned meta-issue for testing the release candidate (see [this issue](https://github.com/bitcoin/bitcoin/issues/17079) for an example) and provide a link to it in the release announcements where useful.
 - Translations on Transifex
-    - Change the auto-update URL for the new major version's resource away from `master` and to the branch e.g. `https://raw.githubusercontent.com/bitcoin/bitcoin/<branch>/src/qt/locale/bitcoin_en.ts`. Do not forget this or it will keep tracking master's translations instead, drifting away from the specific major release.
+    - Change the auto-update URL for the new major version's resource away from `master` and to the branch, e.g. `https://raw.githubusercontent.com/bitcoin/bitcoin/<branch>/src/qt/locale/bitcoin_en.ts`. Do not forget this or it will keep tracking the translations on master instead, drifting away from the specific major release.
  5. fanquake requested review from hebasto on Jun 30, 2021
  6. in doc/release-process.md:41 in 92b8fdf9a1 outdated 
      36 | @@ -37,6 +37,12 @@ Release Process
  37 |    - This update should be reviewed with a reindex-chainstate with assumevalid=0 to catch any defect
  38 |       that causes rejection of blocks in the past history.
  39 |  - Clear the release notes and move them to the wiki (see "Write the release notes" below).
  40 | +- Translations on Transifex
  41 | +    - Create [a new resource](https://www.transifex.com/bitcoin/bitcoin/content/) named after the major version with the slug `[bitcoin.qt-translation-<RRR>x]`, where `RRR` is the major branch number padded with zeros. Use `src/qt/locale/bitcoin_en.ts` to create it.
    hebasto commented at 6:53 AM on July 2, 2021: 
        - Create [a new resource](https://www.transifex.com/bitcoin/bitcoin/content/) named after the major version with the slug `[bitcoin.qt-translation-<RRR>x]`, where `RRR` is the major branch number padded with zeros. Use `src/qt/locale/bitcoin_en.xlf` to create it.
    jonatack commented at 7:36 PM on July 3, 2021:

    done

  7. in doc/release-process.md:42 in 92b8fdf9a1 outdated 
      36 | @@ -37,6 +37,12 @@ Release Process
  37 |    - This update should be reviewed with a reindex-chainstate with assumevalid=0 to catch any defect
  38 |       that causes rejection of blocks in the past history.
  39 |  - Clear the release notes and move them to the wiki (see "Write the release notes" below).
  40 | +- Translations on Transifex
  41 | +    - Create [a new resource](https://www.transifex.com/bitcoin/bitcoin/content/) named after the major version with the slug `[bitcoin.qt-translation-<RRR>x]`, where `RRR` is the major branch number padded with zeros. Use `src/qt/locale/bitcoin_en.ts` to create it.
  42 | +    - Copy over the translations of the previous version using [transifex-migrate-resource](https://github.com/bitcoin-core/bitcoin-maintainer-tools#transifex-migrate-resource).
    hebasto commented at 7:54 AM on July 2, 2021:

    I don't think the transifex-migrate-resource.py script in its current state will work for XLIFF translation files. And Transifex "Translation Memory Fillup" pre-translation option should work for us.

    It's definitely requires @laanwj's opinion.

    hebasto commented at 6:44 PM on July 3, 2021:

    Considering the recent translation update incident, I'd suggest to replace this (outdated?) instruction with the following:

    "Assure that in the project workflow setting (1) the 'Translation Memory Fillup' is enabled, and (2) 'Translation Memory Context Matching' is disabled".

    jonatack commented at 7:36 PM on July 3, 2021:

    Done

    laanwj commented at 12:56 PM on July 15, 2021:

    Thanks for bringing it up, I don't expect transifex-migrate-resource.py to ever work again, for two reasons:

    • As @hebasto mentions, XLIFF probably requires a different treatment.
    • The Transifex API version used by the script (v2) is deprecated and will be removed (Starting April 7th, 2022. apparently). But it was already working less well for recent releases.

    So if it can be replaced by something Transifex provides themselves that would be nice.

  8. in doc/release-process.md:45 in 92b8fdf9a1 outdated 
      36 | @@ -37,6 +37,12 @@ Release Process
  37 |    - This update should be reviewed with a reindex-chainstate with assumevalid=0 to catch any defect
  38 |       that causes rejection of blocks in the past history.
  39 |  - Clear the release notes and move them to the wiki (see "Write the release notes" below).
  40 | +- Translations on Transifex
  41 | +    - Create [a new resource](https://www.transifex.com/bitcoin/bitcoin/content/) named after the major version with the slug `[bitcoin.qt-translation-<RRR>x]`, where `RRR` is the major branch number padded with zeros. Use `src/qt/locale/bitcoin_en.ts` to create it.
  42 | +    - Copy over the translations of the previous version using [transifex-migrate-resource](https://github.com/bitcoin-core/bitcoin-maintainer-tools#transifex-migrate-resource).
  43 | +    - Update the Transifex slug in [`.tx/config`](/.tx/config) to the slug of the resource created in the first step. This identifies which resource the translations will be synchronized from.
  44 | +    - Make an announcement that translators can start translating for the new version. You can use one of the [previous announcements](https://www.transifex.com/bitcoin/bitcoin/announcements/) as a template.
  45 | +    - Change the auto-update URL for the resource to `master`, e.g. `https://raw.githubusercontent.com/bitcoin/bitcoin/master/src/qt/locale/bitcoin_en.ts`. (Do this only after the previous steps, to prevent an auto-update from interfering.)
    hebasto commented at 6:51 PM on July 3, 2021: 
        - Change the auto-update URL for the resource to `master`, e.g. `https://raw.githubusercontent.com/bitcoin/bitcoin/master/src/qt/locale/bitcoin_en.xlf`. (Do this only after the previous steps, to prevent an auto-update from interfering.)
    jonatack commented at 7:37 PM on July 3, 2021:

    Done

  9. in doc/release-process.md:56 in 92b8fdf9a1 outdated 
      51 | @@ -46,6 +52,8 @@ Release Process
  52 |  
  53 |  - Update the versions.
  54 |  - Create a pinned meta-issue for testing the release candidate (see [this issue](https://github.com/bitcoin/bitcoin/issues/17079) for an example) and provide a link to it in the release announcements where useful.
  55 | +- Translations on Transifex
  56 | +    - Change the auto-update URL for the new major version's resource away from `master` and to the branch, e.g. `https://raw.githubusercontent.com/bitcoin/bitcoin/<branch>/src/qt/locale/bitcoin_en.ts`. Do not forget this or it will keep tracking the translations on master instead, drifting away from the specific major release.
    hebasto commented at 6:53 PM on July 3, 2021: 
        - Change the auto-update URL for the new major version's resource away from `master` and to the branch, e.g. `https://raw.githubusercontent.com/bitcoin/bitcoin/<branch>/src/qt/locale/bitcoin_en.xlf`. Do not forget this or it will keep tracking the translations on master instead, drifting away from the specific major release.
    jonatack commented at 7:37 PM on July 3, 2021:

    Done.

  10. hebasto commented at 6:55 PM on July 3, 2021: member

    Approach ACK 92b8fdf9a1a4c2ae16198e2dfd29678ac6779e9b.

  11. doc: Add steps for transifex to release process
    Document how to update settings on and for the transifex website before
and after branch-off of a new release.
    2584929823
  12. doc: Remove unnecessary steps from translations update process
    These have been integrated into the script long ago.
    a16378e501
  13. jonatack force-pushed on Jul 3, 2021
  14. jonatack commented at 7:38 PM on July 3, 2021: member

    Thanks for the feedback @hebasto. LMK if I got it right, happy to update.

  15. hebasto approved
  16. hebasto commented at 7:55 PM on July 3, 2021: member

    ACK a16378e501199144b5aecda57d8bfbc014546764

  17. laanwj commented at 12:57 PM on July 15, 2021: member

    ACK a16378e501199144b5aecda57d8bfbc014546764

  18. laanwj merged this on Jul 15, 2021
  19. laanwj closed this on Jul 15, 2021
  20. laanwj referenced this in commit 529b720c03 on Jul 15, 2021
  21. laanwj referenced this in commit 01ccc22c9c on Jul 15, 2021
  22. jonatack deleted the branch on Jul 15, 2021
  23. fanquake referenced this in commit c35a1d6338 on Jul 18, 2021
  24. sidhujag referenced this in commit e2b54a5524 on Jul 23, 2021
  25. gwillen referenced this in commit 55d94495b0 on Jun 1, 2022
  26. DrahtBot locked this on Aug 18, 2022
Contributors
jonatackjarolrodhebastolaanwj
Labels
Docs
Linked (view graph)
#21440 doc: Add steps for Transifex to release process
github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-13 18:14 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me