Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The GIT Beebox extension allows to translate GIT repositories with a Beebox project.

Table of Contents

Download and install GIT connector

Download the extension from this page: Downloads The file name is Wordbee.Beebox.Extensions.Git.BeeboxPackage.zip.

...

Note that the source code is available from the download link. Feel free to amend to your specific requirements.

Configure a project

Connect to GIT repository

Select an existing Beebox project or create a new one.

...

  • signatureName: A signature included with commits. If not specified then connector uses “Wordbee”

  • signatureEmail: The email included with commits. If not specified then connector uses “noreply@wordbee.com”

To translate additional branches in the repository, then activate the “multi-branch” properties in the next chapter:

  • multibranch: { … } See next chapter

Each Beebox project can have its own configuration.

Configure localization of multiple branches

With this feature you can localize (inside a single Beebox project) any number of branches in your repository. For example, any changes to translatable files in all your feature branches or all your release branches.

Simply add to your configuration a node similar to this:

Code Block
 ...
 "multibranch": {
    "enabled": true,
    "staticBranches": [
		"master",
		"develop",
		"release"
	],
    "regexBranches": [
      "^feature.+"
    ]
  }
  • enabled: Set to true to activate this feature.

  • staticBranches: A list of branch names to localize. You should include here the branch name you set on the branch property.

  • regexBranches: A list of regular expressions to dynamically capture branch names such as all branches prefixed with “feature/”.

How does it work?

  • With each “Auto run”, Beebox will first fetch the latest list of branches and clone any new branches to its “in” directory.

  • It will then pull changes from all listed branches. Note that all branches are cloned to the “in” directory and to subdirectories according to the branch names.

  • Pulled changes trigger translation workflows as any Beebox project would do with new or changed files showing up in the “in” directory.

  • Any finished translations (see below how to automatically transfer and rename in the “in” directory) will be pushed and committed to the respective target branch.

  • The commit history and the Beebox logs show each individual action.

Configure location of translated files

Now you need to define how translated files are pushed back into the repository.

...

Optionally, you can have the translated files be renamed. In the example above we translate “myfile.html” into “myfile-es.html” etc.

Operations

Once the project is configured and linked to a repository, the system will synchronize content with the repository when clicking Autorun.

...

As with any Beebox process, the exact changed “segments” or text blocks will be identified by Beebox and sent into a translation workflow. This cost and time saving feature is not different here than with any of the Beebox workflows!

Logs and error discovery

The GIT connector logs every single action and every single error for your convenience.

...