https://github.com/crazyfactory/uptrans

automatically update translation to upstream
https://github.com/crazyfactory/uptrans

Last synced: 12 months ago
JSON representation

automatically update translation to upstream

• Host: GitHub
• URL: https://github.com/crazyfactory/uptrans
• Owner: crazyfactory
• Created: 2018-11-07T01:25:40.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-06-02T00:05:52.000Z (about 6 years ago)
• Last Synced: 2025-06-20T15:57:29.719Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 3.44 MB
• Stars: 0
• Watchers: 8
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# uptrans

[![Build Status](https://travis-ci.com/crazyfactory/uptrans.svg)](https://travis-ci.com/crazyfactory/uptrans)

[![GitHub issues](https://img.shields.io/github/issues/crazyfactory/uptrans.svg)](https://github.com/crazyfactory/uptrans/issues)

[![codecov](https://codecov.io/gh/crazyfactory/uptrans/branch/master/graph/badge.svg)](https://codecov.io/gh/crazyfactory/uptrans)

[![devDependencies Status](https://david-dm.org/crazyfactory/uptrans/dev-status.svg)](https://david-dm.org/crazyfactory/uptrans?type=dev)

[![dependencies Status](https://david-dm.org/crazyfactory/uptrans/status.svg)](https://david-dm.org/crazyfactory/uptrans) [![Greenkeeper badge](https://badges.greenkeeper.io/crazyfactory/uptrans.svg)](https://greenkeeper.io/)

This CLI tool helps to manage translations on individual packages,

and automatically creates PR to target repository on any new releases on travis.

Any time there's a new release in any package, simply run this CLI, it should automatically create a new PR to target repository with your translations.

## Terminology

### Target repository

Main repository where translations are going to be consumed.

### Source repository

Your package repository where you store translations.

## Usage

Initially you should:

- Add translations on your project.

- setup travis

- set the following environment variables in your source repository:

  - `GH_TOKEN` token which has access to your target repository

  - `LANGUAGE_PATH` path to translation file on your source repository

  - `TARGET_LANGUAGE_PATH` path to translation file to be created on target repository

  - `PROJECT_NAME` best to use name of your package without special characters. This is used name of branch created in target repository

- on `after_success`, simply run this cli

If everything goes well, a new PR should be created in target repository. If not, file an issue.