Crowdin-Tool provides a command line tool that implements convenient git branch conventions for crowdin-cli commands. It helps by aligning your crowdin branch names with the current git branch name, and operating on the master translation branch when on the master branch.
Add this line to your application's Gemfile:
gem 'crowdin-tool'And then execute:
$ bundle
Or install it yourself as:
$ gem install crowdin-tool
Ensure you have a crowdin configuration file crowdin_default.yaml in your project's directory that resembles this setup:
project_identifier: <your project id on crowdin>'
api_key: ''<credentials to be found in project settings page on crowdin>''
base_path: 'can be anything'
files:
-
source: '/config/locales/en/models.en.yml' #source files filter
translation: '/config/locales/%two_letters_code%/models.%two_letters_code%.yml' #where translations live
-
source: '/config/locales/en/en.yml' #source files filter
translation: '/config/locales/%two_letters_code%/%two_letters_code%.yml' #where translations live
-
source: '/config/locales/en/views.en.yml' #source files filter
translation: '/config/locales/%two_letters_code%/views.%two_letters_code%.yml' #where translations live
Then calling
translation init
will initialize the crowdin.yaml for your project with the current base_path.
From your git topic branch that needs to be added to the Crowdin translation platform call
translation create
This will execute the crowdin-cli commands to initialize a new translation version branch with your current git branch name, and upload the keys and initialize the locales.
Use
translation upload
to synchronize the translations in the Crowdin version branch with your working repo.
Finally calling
translation download
will export translations from the Crowdin version branch to your local repo.
After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment. Run bundle exec crowdin-tool to use the code located in this directory, ignoring other installed copies of this gem.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
- Fork it ( https://github.com/[my-github-username]/crowdin-tool/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request