Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
box

GitHub Action

github-transifex-actions

v0.1.3

github-transifex-actions

box

github-transifex-actions

Push your strings automatically to Transifex when PR is ready for translations

Installation

Copy and paste the following snippet into your .yml file.

              

- name: github-transifex-actions

uses: sergioisidoro/github-transifex-action@v0.1.3

Learn more about this action in sergioisidoro/github-transifex-action

Choose a version

github-transifex-action

What does this action do?

  • For now it just pushes the source strings to Transifex, as long as you configure the TX_TOKEN to the enviroment of the job.

Usage

Define a workflow in .github/workflows/transifex.yml (or add a job if you already have defined workflows).

💡 Read more about Configuring a workflow.

on:
  pull_request:
    types: [labeled]

name: "Translations Sync"

jobs:
  push-strings-to-transifex:
    if: github.event.label.name == 'Ready for translations'
    name: push-strings-to-transifex

    runs-on: ubuntu-latest

    steps:
      - name: "Checkout"
        uses: actions/checkout@master

      - name: "Run action"
        env: # Or as an environment variable
            TX_TOKEN: ${{ secrets.TX_TOKEN }}
        uses: docker://sergioisidoro/github-transifex-action:latest

What commands are supported?

The default action is push sources. But you can set different actions through env variables. For example, just define these variables in ENV. If you don't want to push sources, you need to set the variable to false, because it is defined in the defaults

      - name: "Run action"
        env: # Or as an environment variable
            TX_TOKEN: ${{ secrets.TX_TOKEN }}
            PUSH_SOURCES: "true"
            PUSH_TRANSLATIONS: "true"
            PULL_SOURCES: "false"
            PULL_TRANSLATIONS: "true"

Docker image

As Docker images are automatically built and pushed on a merge to master or when a new tag is created in this repository, the recommended way to use this GitHub action is to reference the pre-built Docker image directly, as seen above.

💡 The Docker image can also be executed directly by running

$ docker run --interactive --rm --tty --workdir=/app --volume ${PWD}:/app sergioisidoro/github-transifex-action:latest

For more information, see the Docker Docs: Docker run reference.

Instead of using the latest pre-built Docker image, you can also specify a Docker image tag (which corresponds to the tags released on GitHub):

 on:
   pull_request:
   push:
     branches:
       - master
     tags:
       - "**"

 name: "Continuous Integration"

 jobs:
   github-action-template:
     name: github-action-template

     runs-on: ubuntu-latest

     steps:
       - name: "Checkout"
         uses: actions/checkout@master

       - name: "Run action"
-        uses: docker://sergioisidoro/github-transifex-action:latest
+        uses: docker://sergioisidoro/github-transifex-action:1.2.3

Changelog

Please have a look at CHANGELOG.md.

Contributing

TODO:

  • Passing the resource as an argument

Please have a look at CONTRIBUTING.md.

Code of Conduct

Please have a look at CODE_OF_CONDUCT.md.

License

This package is licensed using the MIT License.