Prakti / gradle-crowdin-cli-plugin

A gradle plugin to utilize the crowdin cli to interact with crowdin

gradle-crowdin-cli-plugin

A gradle plugin to utilize the crowdin cli to interact with crowdin

Usage

The plugin will download the crowin-cli.jar for you into gradle/crowdin-cli/crowdin-cli/crowdin-cli.jar. The plugin always downloads the current latest cli. The download task checks if the zip file on server is newer than the downloaded one and download the newer file automatically.

The plugin adds two task which use the default crowdin config file crowdin.yaml. You can upload source files via crowdinUpload and download translated files via crowdinDownload.

Simple Tasks

task crowdinHelp (type: CrowdinCli) {
    command 'help'
}

task crowdinLint (type: CrowdinCli) {
    command 'lint'
}

Custom Tasks

You can create own task to customize both upload and download depending on you configuration:

task uploadCustom (type: CrowdinUpload) {
  config = 'myCustomConfig.yaml'
}

task downloadCustom (type: CrowdinDownload) {
  config = 'myCustomConfig.yaml'
}

Git Integration

You can use this plugin to automate and integration crowdin into your build pipeline. E.g. let jenkins upload new sources and download translations which are then also commited to git. The plugin checks for the configured files in the config such it can't happen you ci will commit other files except translation files. The used commit message can be customized.

You can configure git integration for each task. By default git integration is disabled.

task downloadCustom (type: CrowdinDownload) {
  git {
   enable = true,
   commitMessage = 'My Custom Commit Message'
  }
}