Travisからの移行


こちらは.travis.ymlの例です(elmトラックから抜粋したものです):

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

これを手早くGitHub Actionsに移行するには、次の手順で進めます:

テンプレート変数を決める

変数 値
<track> elm
<image-name> ubuntu-latest
<action to setup tooling> actions/setup-node@v1
<install dependencies> npm ci (happens inside build.sh)
<code-extensions> .elm

セットアップ用のアクションはこの検索で見つけました。 イメージ名は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も同じ変更ですが、変更された各ファイルを引数としてpr-checkとprスクリプトに渡すbash-fuの部分だけは大きく異なります:

# # .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. チェックをローカルで実行する方法と、それぞれのチェックが何を達成しようとしているのかをドキュメントに書き加えます。