https://github.com/get-bridge/translation-sync

https://github.com/get-bridge/translation-sync

actions github-actions owned-by-frontend-guild

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/get-bridge/translation-sync
• Owner: get-bridge
• Created: 2021-01-27T20:48:52.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-03-25T18:53:04.000Z (over 1 year ago)
• Last Synced: 2025-03-25T19:35:47.779Z (over 1 year ago)
• Topics: actions, github-actions, owned-by-frontend-guild
• Homepage:
• Size: 43 KB
• Stars: 0
• Watchers: 9
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# translation-sync

![ci](https://github.com/get-bridge/translation-sync/workflows/ci/badge.svg)

![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/get-bridge/translation-sync?sort=semver)

Sync translation files to and from an s3-compatible remote bucket. This uses the

[@get-bridge/sync-format-message-translations](https://github.com/get-bridge/sync-format-message-translations) npm package and thus requires authentication with

Github Packages.

## Usage

    - uses: actions/setup-node@v2.4.0

      with:

        node-version: 14

        scope: '@get-bridge'

        registry-url: https://npm.pkg.github.com

    - uses: get-bridge/translation-sync@v1.0.2

      env:

        NODE_AUTH_TOKEN: 

      with:

        config: test/fixtures/config.json

## Customizing

### Inputs

Note: the NODE_AUTH_TOKEN environment variable must be present, otherwise authorization with the `@get-bridge` registry will fail.

- `config`: *Optional* – default: `translation-sync.json`

  The path to the JSON-formatted configuration file. See

  `sync-format-message-translations`'s [own documentation](https://github.com/get-bridge/sync-format-message-translations) for details.

The following inputs can be used as `step.with` keys or via the corresponding environment variable. The `steps.with` values will take precidence over equivalent environment variables.

| Name      | env var                    | Required  | Default                  | Type    | Description                         |

|-----------|----------------------------|-----------|--------------------------|---------|-------------------------------------|

| `config`  | `TRANSLATION_SYNC_CONFIG`  | false     | `translation-sync.json`  | String  | Email associated with the username  |