Skip to content
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.

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

Crowdin config and placeholder locale file #789

Closed
wants to merge 1 commit into from

Conversation

brawaru
Copy link
Contributor

@brawaru brawaru commented Dec 3, 2022

This pull request adds a placeholder locale file and Crowdin configuration to make it possible to connect this repository to Modrinth project on Crowdin without errors.

Without this pull request merged first Crowdin will not be able to migrate translations made during the testing of #738: they will lose attribution or will be lost altogether (if ‘Always import new translations from the repository’ is not enabled for the integration), as well as additional intervention might be required to set up synchronisation from master.

By merging this pull request Crowdin will be able to successfully connect this repository, but there won't be anything to translate until the merge of testing branch for #738 (T-branch). After the merge of T-branch, Crowdin will be able to understand the changes made to master and migrate translations on the site (from T-branch to master) preserving the attribution.

#738 provides instructions on how to connect this repository to Crowdin and information on the matter.

You can see a live example how this was done in https://github.com/Brawaru/test-project-pasta/ and https://crowdin.com/project/brawaru-test-project.

You can also check out this beautiful graph I drew to demonstrate the flow of #738 merge in Discord.

Warning

Before connecting Crowdin, make sure that webhooks are properly set up to ignore all commits made by @modrinth-bot. It might get spammy because the bot doesn't know how to squash merge its commits with translation updates, so it will be creating translations update commits for each file in every language we have enabled on Crowdin. Like this, but worse:

Screenshot of many commits with translation updates

Warning

Make sure @modrinth-bot has enough permissions to create branches, commits and pull requests in this repository. It does need to have (and probably better off without having) permissions to commit to protected master branch.

Note

After connecting Crowdin, @modrinth-bot might create a pull request to update translations for the placeholder file — bunch of empty placeholder files for every locale we have on Crowdin.

You probably want to ignore that pull request until the complete merge of T-branch, after which you should remove master translations branch (called l10n_master by default, but this name can be changed in integration settings on Crowdin) and force synchronisation so that it adapts changes to translation files (if any) to the actual state of master.

@brawaru brawaru marked this pull request as ready for review January 12, 2023 00:16
@brawaru
Copy link
Contributor Author

brawaru commented Jan 12, 2023

Not needed anymore since #738 no longer introduces translations and will act the same.

@brawaru brawaru closed this Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant