Migrar do Travis


Eis um exemplo de .travis.yml (retirado da track elm):

sudo: false
language: node_js
node_js:
  - lts/*
script:
  - bin/fetch-configlet
  - bin/configlet lint
  - bin/build.sh

Para converter isto rapidamente em GitHub Actions, segue os passos seguintes:

Determina as variáveis do modelo

variável valor
<track> elm
<image-name> ubuntu-latest
<action to setup tooling> actions/setup-node@v1
<install dependencies> npm ci (acontece dentro de build.sh)
<code-extensions> .elm

Encontrei a ação de configuração através desta pesquisa. Descobri o nome da imagem ao consultar a distribuição predefinida do Travis.

Determina os passos

  • bin/fetch-configlet: já não precisas disto quando usas o fluxo de trabalho configlet.yml
  • bin/configlet lint: já não precisas disto quando usas o fluxo de trabalho configlet.yml
  • bin/build.sh: um único script que faz tudo

Prepara os «scripts»

Esta track usa a pasta bin, por isso, dentro da pasta bin, cria os seguintes ficheiros:

# bin/pr
bin/build.sh
# bin/pr-check
echo "No checks yet"
# bin/ci
bin/build.sh
# bin/ci-check
echo "No checks yet"

Criar estes binários como ficheiros separados vai permitir otimizar mais tarde. Não é preciso colocar nada inline por agora.

Preenche os modelos

Eis o diff para workflows/ci.yml.

# # .github/workflows/ci.yml

  # This workflow will do a clean install of node dependencies and run tests across different versions
  #
- # Replace <track> with the track name
- # Replace <image-name> with an image to run the jobs on
- # Replace <action to setup tooling> with a github action to setup tooling on the image
- # Replace <install dependencies> with a cli command to install the dependencies
- # Replace <code-extensions> with file extensions that should trigger the workflow
- #
- # Find Github Actions to setup tooling here:
- # - https://github.com/actions/?q=setup&type=&language=
- # - https://github.com/actions/starter-workflows/tree/main/ci
- # - https://github.com/marketplace?type=actions&query=setup
- #
  # Requires scripts:
- # - scripts/ci-check
- # - scripts/ci
+ # - bin/ci-check
+ # - bin/ci

- name: <track> / main
+ name: elm / main

  on:
    push:
      branches: [main]
    workflow_dispatch:

  jobs:
    precheck:
-     runs-on: <image-name>
+     runs-on: ubuntu-latest

      steps:
        - uses: actions/checkout@v2
-       - name: Use <setup tooling>
-         uses: <action to setup tooling>
+       - name: Use Node LTS
+         uses: actions/setup-node@v1
          with:
-           # here, use the LTS/stable version of the track's tooling
-           # node-version: 12.x
+           node-version: 12.x

        - name: Install project dependencies
-         run: <install dependencies>
+         run: npm ci

-       - name: Run exercism/<track> ci pre-check (checks config, lint code) for all exercises
-         run: scripts/ci-check
+       - name: Run exercism/elm ci pre-check (checks config, lint code) for all exercises
+         run: bin/ci-check

    ci:
-     runs-on: <image-name>
+     runs-on: ubuntu-latest

      strategy:
        matrix:
-         # here, add all SUPPORTED versions only
-         # version: [10.x, 12.x, 14.x]
+         version: [10.x, 12.x, 14.x]

      steps:
        - uses: actions/checkout@v2
-       - name: Use <setup tooling> ${{ matrix.version }}
-         uses: <action to setup tooling>
+       - name: Use Node ${{ matrix.version }}
+         uses: actions/setup-node@v1
          with:
-           # below: see how to inject the version
-           # node-version: ${{ matrix.version }}
+           node-version: ${{ matrix.version }}

        - name: Install project dependencies
-         run: <install dependencies>
+         run: npm ci

-       - name: Run exercism/<track> ci (runs tests) for all exercises
-         run: scripts/ci
+       - name: Run exercism/elm ci (runs tests) for all exercises
+         run: bin/ci

workflows/pr.yml tem as mesmas alterações, com a notável exceção do bash-fu que chama os scripts pr-check e pr com cada ficheiro alterado como argumento:

# # .github/workflows/pr.yml

# # ...

-       - name: Run exercism/<track> ci pre-check (stub files, config integrity) for changed exercises
+       - name: Run exercism/elm ci pre-check (stub files, config integrity) for changed exercises
          run: |
            PULL_REQUEST_URL=$(jq -r ".pull_request.url" "$GITHUB_EVENT_PATH")
            curl --url $"${PULL_REQUEST_URL}/files" --header 'authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' | \
-             jq -c '.[] | select(.status == "added" or .status == "modified") | select(.filename | match("\\.(<code-extensions>|md|json)$")) | .filename' | \
+             jq -c '.[] | select(.status == "added" or .status == "modified") | select(.filename | match("\\.(elm|md|json)$")) | .filename' | \
-             xargs -r scripts/pr-check
+             xargs -r bin/pr-check

  # ...

Agora deve funcionar

Isto é suficiente para converter para GitHub Actions, com a possibilidade de otimizares os teus scripts.

  1. Em build.sh, remove os passos que só devem correr uma vez e extrai-os para os ficheiros ci-check.sh e pre-check.sh (dica: podes criar lint.sh e chamá-lo a partir de ambos os «scripts»)
  2. Em pr.sh e pr-check.sh, acrescenta otimizações que usam os argumentos de entrada para determinar que ficheiros ou exercícios verificar.
  3. Acrescenta verificações adicionais
  4. Acrescenta documentação sobre como correr as verificações localmente e o que cada uma tenta alcançar.