Workflow para traduzir README.md em inglês e criar uma versão em do mesmo arquivo em Português README.pt.md

README-TRANSLATE.md

Menu de conteúdos

1. Setup
2. readme.yml

---

Setup

1. Primeiro é necessário criar um Personal access token e é necessário se atentar a dois detalhes:
   • Em expiration é recomendado marcar No expiration para não correr o risco do workflow parar de funcionar e gerar questionamentos
   • Em scopes que é a aba que define os tipos de acesso ao token, é necessário marcar todas as opções de repo e também a de workflow

A imagem abaixo retrata mais ou menos como seu token deve ficar, antes de salvar e gerar. URL para gerar o token: New personal access token

https://github.com/settings/tokens/new

• Após gerar, lembrese de copiar o valor do token criado pois será utilizado posteriormente.

2. Após criar o Personal access token é preciso criar um Secret dentro do repositório que deseja criar o workflow.
   • Primeiro é precisso acessar a seguinte URL https://github.com/<username>/<repository>/settings/secrets/actions/new. Se atente a substituir <username> pelo seu usuário do GitHub e <repository> pelo nome do repositório.
   • Acessando essa URL acima, você deverá cair em uma tela como a demonstrada a seguir, então de um nome pro seu secret e cole o valor do token dentro do textarea. É recomendado criar um nome em maiúsculo separados por underline. Exemplo: EXAMPLE_SECRET.

3. Esse nome de secret criado, será utilizado como valor da chave repo-token dentro do arquivo readme.yml.

No nível demonstrado nos exemplos, ficaria algo assim:

name: Translate README

on:
  push:
    branches:
      - main
      - master
      - docs

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
          repo-token: ${{ secrets.EXAMPLE_SECRET }}
      # Language Codes: https://cloud.google.com/translate/docs/languages  
      - name: Adding README - Portuguese
        uses: dephraiim/translate-readme@main
        with:
          LANG: pt

• O arquivo readme.yml pode ter qualquer nome desde que a extensão seja .yml e é obrigatório estar dentro dessa estrutura de pastas:

/.github/workflows/readme.yml

A pasta .github/ deve ser criada na raíz do projeto.

4. Outro passo importane é verificar se dentro do repositório tem as permissões para que o workflow leia e escreva conteúdo.
   • Acesse a URL a seguir: https://github.com/<username>/<repository>/settings/actions
   • Substitua <username> pelo seu nome de usuário e <repository> pelo nome do repositório.
   • Confira se está marcado a opção Read and write permissions, caso não esteja, marque e clique em salvar.

readme.yml

name: Translate README

on:
  push:
    branches:
      - main
      - master
      - docs

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
          repo-token: ${{ secrets.README_TRANSLATE_SECRET }}
      # Language Codes: https://cloud.google.com/translate/docs/languages  
      - name: Adding README - Portuguese
        uses: dephraiim/translate-readme@main
        with:
          LANG: pt