Travis CI から Actions への移行

このガイドは、Travis CI から Actions に移行するときに役立ちます。概念と構文を比較して類似点を説明し、一般的なタスクに対するさまざまなアプローチを示します。

Actions への移行を開始する前に、その仕組みを理解しておくと便利です。

Actions ジョブを示す簡単な例については、「 Actions のクイックスタート」を参照してください。
重要な Actions の概念については、「 Actions を理解する」を参照してください。

CI タスクがいつ実行されるかを制御できるように、 Actions ワークフロー では、既定で並行実行される ジョブ を使います。各ジョブには、定義した順序で実行される ステップ が含まれています。ジョブのセットアップおよびクリーンアップアクションを実行する必要がある場合は、各ジョブでステップを定義してこれらを実行できます。

Actions と Travis CI は特定の類似点を共有しており、これらを事前に理解しておくと、移行プロセスを円滑に進めることができます。

Travis CI と Actions はどちらも YAML を使用してジョブとワークフローを作成し、これらのファイルはコードのリポジトリに保存されます。 Actions で YAML を使う方法の詳細については、「 Actions を理解する」を参照してください。

Travis CI によって、環境変数を設定し、ステージ間で共有することができます。同様に、 Actions を使うと、ワークフローの変数を定義できます。詳しくは、「変数に情報を格納する」をご覧ください。

Travis CI と Actions の両方に、YAML ファイルで使用できるデフォルトの環境変数が含まれています。 Actions については、「変数に情報を格納する」に記載されています。

Travis CI では、stages を使ってジョブを並列実行できます。同様に、 Actions では jobs を並行実行します。詳しくは、「ワークフローについて」をご覧ください。

Travis CI と Actions はどちらもステータスバッジをサポートしており、ビルドが成功したか失敗したかを示すことができます。詳しくは、「ワークフロー状態バッジの追加」をご覧ください。

Travis CI と Actions の両方でマトリックスがサポートされるため、オペレーティングシステムとソフトウェアパッケージの組み合わせを使ってテストを実行できます。詳しくは、「ワークフローでのジョブのバリエーションの実行」をご覧ください。

以下は、各システムの構文を比較した例です。

matrix:
  include:
    - rvm: '2.5'
    - rvm: '2.6.3'

jobs:
  build:
    strategy:
      matrix:
        ruby: ['2.5', '2.6.3']

Travis CI と Actions はどちらも、CI を特定のブランチにターゲット設定できます。詳しくは、「 Actions　のワークフロー構文」をご覧ください。

以下は、それぞれのシステムにおける構文の例です。

branches:
  only:
    - main
    - 'mona/octocat'

on:
  push:
    branches:
      - main
      - 'mona/octocat'

Travis CI と Actions はどちらも、サブモジュールをリポジトリクローンに含めるかどうかの制御ができます。

以下は、それぞれのシステムにおける構文の例です。

git:
  submodules: false

- uses: actions/checkout@v4
  with:
    submodules: false

Travis CI と Actions はどちらも、カスタム変数をテストマトリックスに追加できます。これにより、後のステップで変数を参照できます。

Actions では、include キーを使って、カスタム環境変数をマトリックスに追加できます。この例では、node-version のマトリックスエントリはそれぞれ、環境変数 site と datacenter に異なる値を使用するように構成されています。次に Echo site details ステップでは、env: ${{ matrix.env }} を使用してカスタム変数を参照します。

name: Node.js CI
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
       include:
         - node-version: '14.x'
           site: "prod"
           datacenter: "site-a"
         - node-version: '16.x'
           site: "dev"
           datacenter: "site-b"
    steps:
      - name: Echo site details
        env:
          SITE: ${{ matrix.site }}
          DATACENTER: ${{ matrix.datacenter }}
        run: echo $SITE $DATACENTER

Travis CI から移行する場合は、 Actions の次の主要機能を考慮してください。

Actions を使用すると、シークレットを保存して、ジョブで参照できます。 Actions Organization は、Organization のシークレットにアクセスできるリポジトリを制限できます。デプロイ保護規則では、環境シークレットにアクセスするためのワークフローに対して手動承認が必要になる場合があります。詳しくは、「シークレットについて」をご覧ください。

Actions には、成果物のストレージの統合サポートが含まれており、ワークフロー内のジョブ間でファイルを共有できます。結果のファイルを保存して、他のワークフローと共有することもできます。詳しくは、「 Actions を理解する」をご覧ください。

ジョブに特定のハードウェアまたはソフトウェアが必要な場合、 Actions を使用すると、自分のランナーをホストして、処理のためにジョブをそれらに送信できます。 Actions では、ポリシーを使用してこれらのランナーへのアクセス方法を制御し、Organization またはリポジトリレベルでアクセスを許可することもできます。詳しくは、「自分のランナーをホストする」をご覧ください。

Actions の同時ジョブとワークフローの実行時間は、プランによって異なります。詳しくは、「使用制限、支払い、管理」をご覧ください。

Actions でさまざまな言語を使用する場合、ジョブにステップを作成して言語の依存関係を設定できます。特定の言語の操作の詳細については、「ビルドとテスト」を参照してください。

Actions では、run ステップを使ってスクリプトまたはシェルコマンドを実行できます。特定のシェルを使うには、スクリプトへのパスを指定するときに shell 型を指定できます。詳しくは、「 Actions　のワークフロー構文」をご覧ください。

次に例を示します。

steps:
  - name: Run build script
    run: ././scripts/build.sh
    shell: bash

Actions に移行する場合、エラー処理にはさまざまな方法があり、注意が必要です。

Actions は、いずれかのステップでエラーコードが返された場合、すぐにジョブを停止します。詳しくは、「 Actions　のワークフロー構文」をご覧ください。

Actions では、if 条件文を使って、特定の状況でジョブまたはステップを実行します。たとえば、あるステップは、別のステップで failure() が発生したときに実行できます。詳しくは、「 Actions　のワークフロー構文」をご覧ください。また、continue-on-error を使って、ジョブが失敗したときにワークフロー実行が停止しないようにすることもできます。

条件式でジョブを実行するために、Travis CI と Actions では同様の if 条件構文を共有します。 Actions を使うと、if 条件文を使って、条件が満たされない限りジョブまたはステップが実行されないようにすることができます。詳しくは、「ワークフローとアクションで式を評価する」をご覧ください。

次の例は、ステップを実行するかどうかを if 条件文で制御する方法を示しています。

jobs:
  conditional:
    runs-on: ubuntu-latest
    steps:
      - run: echo "This step runs with str equals 'ABC' and num equals 123"
        if: env.str == 'ABC' && env.num == 123

Travis CI が_フェーズ_を使用して_ステップ_を実行する場合、 Actions には_アクション_を実行する_ステップ_があります。 Marketplace でビルド済みアクションを見つけることも、独自のアクションを作成することもできます。詳しくは、「自動化の共有」をご覧ください。

以下は、それぞれのシステムにおける構文の例です。

language: python
python:
  - "3.7"

script:
  - python script.py

jobs:
  run_python:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-python@v5
        with:
          python-version: '3.7'
          architecture: 'x64'
      - run: python script.py

Travis CIと Actionsでは、後で利用できるよう依存関係を手動でキャッシュできます。

これらの例は、各システムのキャッシュ構文を示しています。

language: node_js
cache: npm

- name: Cache node modules
  uses: actions/cache@v4
  with:
    path: ~/.npm
    key: v1-npm-deps-${{ hashFiles('**/package-lock.json') }}
    restore-keys: v1-npm-deps-

このセクションは、 ActionsとTravis CIでの一般的なタスクの実行方法を比較します。

Actionsのジョブではカスタムの環境変数を作成できます。

env:
  - MAVEN_PATH="/usr/local/maven"

jobs:
  maven-build:
    env:
      MAVEN_PATH: '/usr/local/maven'

install:
  - npm install
script:
  - npm run build
  - npm test

name: Node.js CI
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Use Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '16.x'
      - run: npm install
      - run: npm run build
      - run: npm test

Actions の主な機能について引き続き学習するには、「ワークフローの書き込み」を参照してください。

Travis CI から Actions への移行

この記事の内容