-
Notifications
You must be signed in to change notification settings - Fork 3
Home
The Github Actions Crowdin integration is a method to upload sources to a Crowdin Enterprise project and download the translations. The downloaded translations are stored in a separate branch and an PR is created depending on the configuration. Techn 5C56 ically you could create an GitHub action to auto-merge PRs from the Crowdin branch and delete the branch.
The Pull Requests need to be merged manually (unless a GitHub action is created), the branch should be deleted to make sure it's always up-to-date
Location: Configuration/crowdin.yml
project_id: 102 = The unique ID within Crowdin
api_token_env: CROWDIN_PERSONAL_TOKEN = The Secret name within the repository settings
base_path: = Where to start in the repository
base_url: "https://joomla.crowdin.com" = Is the main Crowdin address for Joomla.
preserve_hierarchy: true = Save directory structure on server
Files Crowdin Configuration File
There are various ways to do the configuration file and as well various options to let the system take the actions you want.
The below method is the one mostly used in our projects.
You have a source (which file), a dest (where should it be in Crowdin), translation (how should the translation be downloaded and stored), type (which filetype should it use).
files:
- source: /Brochures/Joomla4/en-GB/joomla4-2021.idml
dest: 'Brochures/joomla4-2021.idml'
translation: /Brochures/Joomla4/%locale%/joomla4-2021.idml
type: idml
https://support.crowdin.com/github-crowdin-action/
The GitHub action is basically the engine, the cronjob which does the 2-way communication between Crowdin and GitHub.
Depending on the settings used, it takes certain actions for the configuration file defined in the action.
Technically you are able to use multiple GitHub actions and thus configuration files.
What all options do is described on their own GitHub repository and from time to time a new version and options come available.
https://github.com/crowdin/github-action