Skip to content

[Backport 13.4] Explain branches in detail for GitHub workflow for Crowdin #6265

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
linawolf merged 1 commit into from
Nov 30, 2025
Merged

[Backport 13.4] Explain branches in detail for GitHub workflow for Crowdin #6265

Show file tree
Hide file tree
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
7 changes: 7 additions & 0 deletions ...ion/ApiOverview/Localization/TranslationServer/Crowdin/ExtensionIntegration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,13 @@ Step-by-step instructions for GitHub
``<source>`` and ``<target>`` elements. If the ``<source>`` elements are missing,
Crowdin will not be able to match the translations with the original English labels.

.. important::
Using the recommended GitHub workflow the GitHub default branch can be
mapped to the Crowdin branch name via the attribute :yaml:`crowdin_branch_name`.
It is recommended that you always use `main` as the Crowdin branch name.
**More than one Crowdin branch (for example via different
GitHub branches) is not supported by the Crowdin Bridge!**

3. Approve imported translations

After importing existing translations, they will arrive in Crowdin in an
Expand Down
34 changes: 23 additions & 11 deletions Documentation/ApiOverview/Localization/TranslationServer/Crowdin/Faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,17 +141,29 @@ checkbox.
Why is translated content not available in TYPO3?
-------------------------------------------------

* The translated strings are not approved. As an owner of the Crowdin project
(for example, if you're the extension owner) or as proofreader you can approve
strings by yourself. Otherwise please ask in the Slack channel
`#typo3-localization-team <https://typo3.slack.com/app_redirect?channel=CR75200FL>`__
for approval. With the next run of the Crowdin Bridge the translations
should be available (approx. every two hours).

* Only translations provided from the following default branches in your
repository are used: `main`, `master`, `release`, `develop`, `dev`,
`development`. If you use other branches, the translations are not
available — even if they are translated in Crowdin.
Approval is missing
~~~~~~~~~~~~~~~~~~~

The translated strings are not approved. As an owner of the Crowdin project
(for example, if you're the extension owner) or as proofreader you can approve
strings by yourself. Otherwise please ask in the Slack channel
`#typo3-localization-team <https://typo3.slack.com/app_redirect?channel=CR75200FL>`__
for approval. With the next run of the Crowdin Bridge the translations
should be available (approx. every two hours).

Integration branch is not recognized
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If the legacy Crowdin <> GitHub integration is used, only translations
provided from the following default branches in your repository are used:
`main`, `master`, `release`, `develop`, `dev`, `development`. If you use
other branches, the translations are not available — even if they are
translated in Crowdin.

It is recommended to configure the
:ref:`GitHub workflow as integration for Crowdin <crowdin-extension-integration-github>`,
this way you define the `crowdin_branch_name` which can be set to
`main` — independently of your GitHub default branch.

.. index:: Crowdin; Reconnect your project
.. _reconnect-your-project:
Expand Down