Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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 month ago
JSON representation

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
`@get-bridge/sync-format-message-translations` and thus requires authentication with
Github Packages.

## Usage

- uses: actions/[email protected]
with:
node-version: 14
scope: '@get-bridge'
registry-url: https://npm.pkg.github.com

- uses: get-bridge/[email protected]
env:
NODE_AUTH_TOKEN:
with:
config: test/fixtures/config.json

## Customizing

### Inputs

Note: the NODE_AUTH_TOKEN environemnt 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
`@get-bridge/sync-format-message-translations`'s own documentation 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 |