debian-mirror-gitlab/doc/development/i18n/merging_translations.md

56 lines
2.9 KiB
Markdown
Raw Normal View History

2020-04-22 19:07:51 +05:30
# Merging translations from CrowdIn
2018-12-05 23:21:45 +05:30
2020-04-22 19:07:51 +05:30
CrowdIn automatically syncs the `gitlab.pot` file with the CrowdIn service, presenting
2019-12-26 22:10:19 +05:30
newly added externalized strings to the community of translators.
2018-12-05 23:21:45 +05:30
2020-04-22 19:07:51 +05:30
[GitLab CrowdIn Bot](https://gitlab.com/gitlab-crowdin-bot) also creates merge requests
2019-12-26 22:10:19 +05:30
to take newly approved translation submissions and merge them into the `locale/<language>/gitlab.po`
2020-03-13 15:44:24 +05:30
files. Check the [merge requests created by `gitlab-crowdin-bot`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests?scope=all&utf8=%E2%9C%93&state=opened&author_username=gitlab-crowdin-bot)
2019-12-26 22:10:19 +05:30
to see new and merged merge requests.
2018-12-05 23:21:45 +05:30
## Validation
2020-04-22 19:07:51 +05:30
By default CrowdIn commits translations with `[skip ci]` in the commit
2018-12-05 23:21:45 +05:30
message. This is done to avoid a bunch of pipelines being run. Before
merging translations, make sure to trigger a pipeline to validate
2020-04-22 19:07:51 +05:30
translations, we have static analysis validating things CrowdIn
2019-12-21 20:55:43 +05:30
doesn't do. Create a new pipeline at `https://gitlab.com/gitlab-org/gitlab/pipelines/new`
(need Developer access permissions) for the `master-i18n` branch.
2018-12-05 23:21:45 +05:30
If there are validation errors, the easiest solution is to disapprove
2020-04-22 19:07:51 +05:30
the offending string in CrowdIn, leaving a comment with what is
2018-12-05 23:21:45 +05:30
required to fix the offense. There is an
2019-12-26 22:10:19 +05:30
[issue](https://gitlab.com/gitlab-org/gitlab/issues/23256)
2018-12-05 23:21:45 +05:30
suggesting to automate this process. Disapproving will exclude the
invalid translation, the merge request will be updated within a few
minutes.
2020-04-22 19:07:51 +05:30
It might be handy to pause the integration on the CrowdIn side for a
2018-12-05 23:21:45 +05:30
little while so translations don't keep coming. This can be done by
2020-04-22 19:07:51 +05:30
clicking `Pause sync` on the [CrowdIn integration settings
2018-12-05 23:21:45 +05:30
page](https://translate.gitlab.com/project/gitlab-ee/settings#integration).
When all failures are resolved, the translations need to be double
2019-12-26 22:10:19 +05:30
checked once more as discussed in [confidential issue](../../user/project/issues/confidential_issues.md) `https://gitlab.com/gitlab-org/gitlab/issues/19485`.
2018-12-05 23:21:45 +05:30
## Merging translations
When all translations are found good and pipelines pass the
2019-12-26 22:10:19 +05:30
translations can be merged into the master branch. When merging the translations,
2020-04-22 19:07:51 +05:30
make sure to check the **Remove source branch** checkbox, so CrowdIn recreates the
2019-12-26 22:10:19 +05:30
`master-i18n` from master after the new translation was merged.
We are discussing [automating this entire process](https://gitlab.com/gitlab-org/gitlab/issues/19896).
2018-12-05 23:21:45 +05:30
## Recreate the merge request
2020-04-22 19:07:51 +05:30
CrowdIn creates a new merge request as soon as the old one is closed
2018-12-05 23:21:45 +05:30
or merged. But it won't recreate the `master-i18n` branch every
2020-04-22 19:07:51 +05:30
time. To force CrowdIn to recreate the branch, close any [open merge
2020-03-13 15:44:24 +05:30
request](https://gitlab.com/gitlab-org/gitlab/-/merge_requests?scope=all&utf8=%E2%9C%93&state=opened&author_username=gitlab-crowdin-bot)
2018-12-05 23:21:45 +05:30
and delete the
2019-12-21 20:55:43 +05:30
[`master-18n`](https://gitlab.com/gitlab-org/gitlab/-/branches/all?utf8=✓&search=master-i18n).
2018-12-05 23:21:45 +05:30
This might be needed when the merge request contains failures that
have been fixed on master.