JenkinsからGitHub Actionsへの移行

GitHub Actions の支払いを管理する GitHubは、macOSランナーのホストにMacStadiumを使用しています。

はじめに

JenkinsとGitHub Actionsは、どちらも自動的にコードのビルド、テスト、公開、リリース、デプロイを行うワークフローを作成できます。 JenkinsとGitHub Actionsは、ワークフローの設定において似ているところがあります。

• Jenkinsは宣言的パイプラインを使ってワークフローを作成します。これはGitHub Actionsのワークフローファイルに似ています。
• Jenkinsはステージを使ってステップの集合を実行しますが、GitHub Actionsは1つ以上のステップもしくは個別のコマンドをグループ化するのにジョブを使います。
• JenkinsとGitHub Actionsはコンテナベースのビルドをサポートします。 詳しい情報については「Docker コンテナアクションを作成する」を参照してください。
• ステップもしくはタスクは、再利用とコミュニティとの共有が可能です。

詳しい情報については、「GitHub Actionsの中核的概念」を参照してください。

主要な差異

• Jenkinsには、パイプラインの作成用の構文として、宣言的パイプラインとスクリプトパイプラインの2種類があります。 GitHub Actionsは、ワークフローと設定ファイルの作成にYAMLを使います。 詳しい情報については、「GitHub Actionsのワークフロー構文」を参照してください。
• Jenkinsのデプロイメントは通常セルフホストであり、ユーザが自身のデータセンター内のサーバーをメンテナンスします。 GitHub Actionsは、ジョブの実行に利用できる独自のランナーをホストするハイブリッドクラウドのアプローチを提供しながら、セルフホストランナーもサポートします。 詳しい情報については「セルフホストランナーについて」を参照してください。

機能の比較

ビルドの分配

Jenkinsでは、ビルドを単一のビルドエージェントに送信することも、複数のエージェントに対して分配することもできます。 それらのエージェントを、オペレーティングシステムの種類などの様々な属性に従って分類することもできます。

同様に、GitHub Actions はジョブを GitHub ホストまたはセルフホストランナーに送信でき、ラベルを使用してさまざまな属性に従ってランナーを分類できます。 以下の表は、分散ビルドの概念がJenkinsとGitHub Actionsでどのように実装されているかを比較しています。

セクションを利用したパイプラインの整理

Jenkinsは、宣言的パイプラインを複数のセクションに分割します。 同様に、GitHub Actions はワークフローを個別のセクションに編成します。 以下の表は、JenkinsのセクションをGitHub Actionsのワークフローと比較しています。

ディレクティブの利用

Jenkinsは、宣言的パイプラインを管理するためにディレクティブを使います。 それらのディレクティブは、ワークフローの特徴と、その実行方法を定義します。 以下の表は、それらのディレクティブがGitHub Actionsの概念とどのように対応するかを示しています。

シーケンシャルなステージの利用

並列なジョブの処理

Jenkinsはステージとステップを並行して実行できますが、GitHub Actionsが並行に処理できるのは現時点ではジョブだけです。

ビルドマトリックス

GitHub ActionsとJenkinsはどちらも、ビルドマトリックスを使って様々なシステムの組み合わせを定義できます。

ステップを使ったタスクの実行

Jenkinsはステップをまとめてステージにグループ化します。 それらの各ステップは、スクリプト、関数、コマンドなどです。 同様に、GitHub Actionsはジョブを使って特定のステップのグループを実行します。

一般的なタスクの例

cronで実行するようパイプラインをスケジュール

  pipeline {
   agent any
    triggers {
      cron('H/15 * * * 1-5')
    }
 }

on:
schedule:
  - cron:  '*/15 * * * 1-5'

パイプライン中での環境変数の設定

pipeline {
  agent any
  environment {
    MAVEN_PATH = '/usr/local/maven'
  }
}

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

上流のプロジェクトからのビルド

pipeline {
  triggers {
    upstream(
      upstreamProjects: 'job1,job2',
      threshold: hudson.model.Result.SUCCESS)
    }
  }
}

jobs:
  job1:
  job2:
    needs: job1
  job3:
    needs: [job1, job2]

複数のオペレーティングシステムでのビルド

pipeline {
agent none
stages {
stage('Run Tests') {
  matrix {
    axes {
      axis {
        name: 'PLATFORM'
        values: 'macos', 'linux'
      }
    }
    agent { label "${PLATFORM}" }
    stages {
      stage('test') {
        tools { nodejs "node-12" }
        steps {
          dir("scripts/myapp") {
            sh(script: "npm install -g bats")
            sh(script: "bats tests")
          }
        }
      }
    }
  }
}
}
}

name: demo-workflow
on:
  push:
jobs:
  test:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [macos-latest, ubuntu-latest]
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          node-version: 12
      - run: npm install -g bats
      - run: bats tests
        working-directory: scripts/myapp