Перехід з Travis

Ось приклад .travis.yml (узятий із треку elm):

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

Щоб швидко перетворити це на GitHub Actions, виконайте такі кроки:

Визначення змінних шаблону

Дію для налаштування знайдено за допомогою цього пошуку. Назву образу знайдено, поглянувши на типовий дистрибутив для Travis.

Визначення кроків

• bin/fetch-configlet: більше не потрібно, якщо використовувати робочий процес configlet.yml
• bin/configlet lint: більше не потрібно, якщо використовувати робочий процес configlet.yml
• bin/build.sh: єдиний скрипт, який робить усе

Підготовка «скриптів»

Цей трек використовує теку bin, тож усередині теки bin створіть такі файли:

# bin/pr
bin/build.sh

# bin/pr-check
echo "No checks yet"

# bin/ci
bin/build.sh

# bin/ci-check
echo "No checks yet"

Якщо створити їх як окремі бінарники, це дасть змогу оптимізувати все пізніше. Зараз немає потреби щось вбудовувати.

Заповнення шаблонів

Ось діф для 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 містить ті самі зміни, за одним помітним винятком: трюк із bash, який викликає скрипти pr-check і pr, передаючи кожен змінений файл як аргумент:

# # .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

  # ...

Тепер усе має працювати

Цього достатньо, щоб перейти на GitHub Actions, а скрипти можна буде оптимізувати згодом.

1. З build.sh приберіть кроки, які мають виконуватися лише один раз, і винесіть їх у файли ci-check.sh і pre-check.sh (підказка: можна створити lint.sh і викликати його з обох «скриптів»)
2. До pr.sh і pr-check.sh додайте оптимізації, які використовують вхідні аргументи, щоб визначати, які файли чи вправи перевіряти.
3. Додайте додаткові перевірки
4. Додайте документацію про те, як запускати перевірки локально і чого намагається досягти кожна з них.