Skip to main content

JenkinsからGitHub Actionsへの移行

GitHub ActionsとJenkinsには複数の相似点があり、そのためGitHub Actionsへの移行は比較的単純です。

注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。

はじめに

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 ホストまたはセルフホストランナーに送信でき、ラベルを使用してさまざまな属性に従ってランナーを分類できます。 詳しくは、「GitHub Actions を理解する」と「セルフホスト ランナーについて」をご覧ください。

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

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

JenkinsのディレクティブGitHub Actions
agentjobs.<job_id>.runs-on
jobs.<job_id>.container
post
stagesjobs
stepsjobs.<job_id>.steps

ディレクティブの使用

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

JenkinsのディレクティブGitHub Actions
environmentjobs.<job_id>.env
jobs.<job_id>.steps[*].env
optionsjobs.<job_id>.strategy
jobs.<job_id>.strategy.fail-fast
jobs.<job_id>.timeout-minutes
parametersinputs
outputs
triggerson
on.<event_name>.types
on.<push>.<branches|tags>
on.<pull_request>.<branches>
on.<push|pull_request>.paths
triggers { upstreamprojects() }jobs.<job_id>.needs
Jenkins の cron 構文on.schedule
stagejobs.<job_id>
jobs.<job_id>.name
toolsGitHub ホステッド ランナーの仕様
inputinputs
whenjobs.<job_id>.if

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

並列なジョブの処理

Jenkins は stagessteps を並列に実行できますが、GitHub Actions が並列に実行できるのは現時点ではジョブだけです。

Jenkinsの並列処理GitHub Actions
paralleljobs.<job_id>.strategy.max-parallel

Matrix

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

JenkinsGitHub Actions
axisstrategy/matrix
context
stagessteps-context
excludes

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

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

JenkinsのステップGitHub Actions
scriptjobs.<job_id>.steps

一般的なタスクの例

cron で実行するパイプラインのスケジュール設定

Jenkinsのパイプライン GitHub Actionsのワークフロー
pipeline {
  agent any
  triggers {
    cron('H/15 * * * 1-5')
  }
}
on:
  schedule:
    - cron: '*/15 * * * 1-5'

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

Jenkinsのパイプライン GitHub Actionsのワークフロー
pipeline {
  agent any
  environment {
    MAVEN_PATH = '/usr/local/maven'
  }
}
jobs:
  maven-build:
    env:
      MAVEN_PATH: '/usr/local/maven'

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

Jenkinsのパイプライン GitHub Actionsのワークフロー
pipeline {
  triggers {
    upstream(
      upstreamProjects: 'job1,job2',
      threshold: hudson.model.Result.SUCCESS
    )
  }
}
jobs:
  job1:
  job2:
    needs: job1
  job3:
    needs: [job1, job2]

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

Jenkinsのパイプライン GitHub Actionsのワークフロー
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@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 12
      - run: npm install -g bats
      - run: bats tests
        working-directory: scripts/myapp