Skip to content
book-open

GitHub Action

Translate Readme Action

v1 Latest version

Translate Readme Action

book-open

Translate Readme Action

Translate the Readme to another language

Installation

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

              

- name: Translate Readme Action

uses: ephraimduncan/translate-readme@v1

Learn more about this action in ephraimduncan/translate-readme

Choose a version

Translate Readme Action

GitHub Action to translate Readme to any language

This is a GitHub Action that automatically translate the readme in your repo to a specified language.

A submission for the DEV: GitHub Actions For Open Source! hackathon

Setup

  1. Add a workflow file to your project (e.g. .github/workflows/readme.yml):

    name: Translate Readme
    
    on:
      push:
        branches:
          - main
          - master
    
    jobs:
      build:
        runs-on: ubuntu-latest
        steps:
          - uses: actions/checkout@v2
          - name: Setup Node.js
            uses: actions/setup-node@v1
            with:
              node-version: 12.x
          - name: Adding License
            uses: dephraiim/translate-readme@v1
            with:
              LANG: la
              # ISO Langusge Code.
              # Supported Languages below

Configuration

Options

You can configure the action further with the following options:

  • LANG: The language you want to translate your readme to. The default is Simplified Chinese. (I'm a Ghanaian) The supported languages can be found below. (default: zh-CH) (required: false)

Supported Languages

Languages supported can be found here https://cloud.google.com/translate/docs/languages

Issues

Check here for issues related to this action.

Development

Suggestions and contributions are always welcome!

LICENSE

MIT