https://github.com/vuejs-translations/ryu-cho

The GitHub Action to track diffs between 2 repositories.
https://github.com/vuejs-translations/ryu-cho

Last synced: 5 days ago
JSON representation

The GitHub Action to track diffs between 2 repositories.

• Host: GitHub
• URL: https://github.com/vuejs-translations/ryu-cho
• Owner: vuejs-translations
• License: mit
• Created: 2021-02-26T09:12:33.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-10T11:49:20.000Z (7 months ago)
• Last Synced: 2024-10-31T10:49:41.271Z (14 days ago)
• Language: TypeScript
• Homepage:
• Size: 138 KB
• Stars: 26
• Watchers: 8
• Forks: 9
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ryu-Cho

Ryu-Cho (means "fluent" in Japanese) is a GitHub Action that creates issues and PRs from the head repo based on its commit. Very useful for tracking diffs between translating docs, for example.

Ryu-Cho is a fork of [Che-Tsumi](https://github.com/vuejs-jp/che-tsumi). It works almost identical, while Che-Tsumi works as a stand-alone service while Ryu-Cho works with GitHub Action.

## Usage

Ryu-Cho requires GitHub authentication to create issues and PRs to the repository. At first, create [Encrypted secret](https://docs.github.com/en/actions/reference/encrypted-secrets) that has access to the repository which you want to set up Ryu-Cho. Here we assume you've created a secret called `ACCESS_TOKEN`.

Next, create `.github/workflows/ryu-cho.yml` file in your repository. Then configure the yaml file.

```yml

name: ryu-cho

on:

  # Schedule the interval of the checks.

  schedule:

    - cron: '*/5 * * * *'

jobs:

  ryu-cho:

    name: Ryu Cho

    runs-on: ubuntu-latest

    steps:

      - uses: vuejs-translations/ryu-cho@v1

        with:

          # GitHub access token. Required.

          access-token: ${{ secrets.ACCESS_TOKEN }}

          # Git user name to use when making issues and PRs. Required.

          username: johndoe

          # Git email address to use when making issues and PRs. Required.

          email: "[email protected]"

          # The url for the upstream repo. This is the repository that you

          # set up Ryu-Cho. Required.

          upstream-repo: https://github.com/vuejs-translations/docs-ja.git

          # The branch for the upstream repo. Optional. Defaults to `main`.

          upstream-repo-branch: main

          # The head repo to track. This is the repository you want to

          # take a diff. Required.

          head-repo: https://github.com/vuejs/docs.git

          # The branch for the head repo. Optional. Defaults to `main`.

          head-repo-branch: main

          # The git commit sha of head repo to start tracking. Ryu-Cho will

          # only track commit from this hash. Required.

          track-from: 4ed8b2f83a2f149734f3c5ecb6438309bd85a9e5

          # File path to track. In this example, Ryu-Cho will only track

          # commits that modified files under `docs` folder. Optional.

          path-starts-with: docs/

          # GitHub workflow name that runs Ryu-Cho. This is required since

          # Ryu-Cho determines the last run by looking into last workflow

          # run timestamp. Optional. Defaults to `ryu-cho`.

          workflow-name: ryu-cho

```

The important part to note is that you must match the GitHub workflow name to `workflow-name` option.