Migrieren von Jenkins zu GitHub Actions

Hinweis

Auf GitHub Enterprise Server gehostete Runner werden aktuell nicht auf GitHub unterstützt.

Einführung

Jenkins und GitHub Actions ermöglichen Ihnen beide, Workflows zu erstellen, mit denen Code automatisch kompiliert, getestet, veröffentlicht, freigegeben und bereitgestellt wird. Jenkins und GitHub Actions teilen einige Ähnlichkeiten in der Workflowkonfiguration:

Jenkins erstellt Workflows mit deklarativen Pipelines, die GitHub Actions Workflow-Dateien ähneln.
Jenkins verwendet Phasen, um eine Reihe von Schritten auszuführen, während GitHub Actions Jobs verwendet, um einen oder mehrere Schritte oder einzelne Befehle zu gruppieren.
Jenkins und GitHub Actions unterstützen containerbasierte Builds. Weitere Informationen finden Sie unter Creating a Docker container action (Erstellen einer Docker-Containeraktion).
Schritte oder Aufgaben können wiederverwendet und in der Community gemeinsam genutzt werden.

Weitere Informationen finden Sie unter Grundlegendes zu GitHub Actions.

Wichtige Unterschiede

Jenkins hat zwei Arten von Syntax zur Erzeugung von Pipelines: Deklarative Pipeline und „Scripted“ (Skript-basierte) Pipeline. GitHub Actions verwendet YAML zum Erstellen von Workflows und Konfigurationsdateien. Weitere Informationen finden Sie unter Workflowsyntax für GitHub Actions.
Die Jenkins-Deployments sind üblicherweise selbstgehostet, wobei die Benutzer:innen die Server in ihren eigenen Rechenzentren verwalten. GitHub Actions bietet einen Hybrid-Cloud-Ansatz, indem es eigene Runner hostet, die Sie zum Ausführen von Jobs verwenden können, und gleichzeitig selbstgehostete Runner unterstützt. Weitere Informationen finden Sie unter Selbstgehosteten Runnern.

Funktionaltäten im Vergleich

Deine Builds verteilen

Mit Jenkins kannst Du Builds an einen einzelnen Build-Agenten senden oder sie über mehrere Agenten verteilen. Du kannst diese Agenten auch nach verschiedenen Attributen klassifizieren, wie zum Beispiel Arten von Betriebssystemen.

Ebenso kann GitHub Actions Jobs an von GitHub gehostete oder selbstgehostete Runner senden, und Sie können Labels verwenden, um Runner anhand verschiedener Attribute zu klassifizieren. Weitere Informationen findest du unter Grundlegendes zu GitHub Actions und Selbstgehosteten Runnern.

Sektionen verwenden, um Pipelines zu organisieren

Jenkins teilt seine deklarativen Pipelines in mehrere Abschnitte auf. Ebenso organisiert GitHub Actions seine Workflows in verschiedene Abschnitte. In der folgenden Tabelle werden die Abschnitte Von Jenkins mit dem GitHub Actions Workflow verglichen.

Anweisungen in Jenkins	GitHub Actions
`agent`	`jobs.<job_id>.runs-on` `jobs.<job_id>.container`
`post`	Keine
`stages`	`jobs`
`steps`	`jobs.<job_id>.steps`

using-Direktiven

Jenkins verwendet Anweisungen, um deklarative Pipelines zu verwalten. Diese Anweisungen definieren die Merkmale Deines Workflows und die Art und weise, wie dieser ausgeführt wird. In der folgenden Tabelle wird veranschaulicht, wie diese Direktiven Konzepten zugeordnet werden GitHub Actions.

Anweisungen in Jenkins	GitHub Actions
`environment`	`jobs.<job_id>.env` `jobs.<job_id>.steps[*].env`
`options`	`jobs.<job_id>.strategy` `jobs.<job_id>.strategy.fail-fast` `jobs.<job_id>.timeout-minutes`
`parameters`	`inputs` `outputs`
`triggers`	`on` `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-Syntax	`on.schedule`
`stage`	`jobs.<job_id>` `jobs.<job_id>.name`
`tools`
Spezifikationen für von GitHub gehostete Runner
`input`	`inputs`
`when`	`jobs.<job_id>.if`

Sequenzielle „Stages“ (Phasen) verwenden

Parallele Verarbeitung von Aufträgen

Jenkins kann stages und steps parallel ausführen, während GitHub Actions derzeit nur Jobs parallel ausführt.

Jenkins Parallel	GitHub Actions
`parallel`	`jobs.<job_id>.strategy.max-parallel`

Matrix

Sowohl GitHub Actions als auch Jenkins ermöglichen Ihnen, eine Matrix zu verwenden, um verschiedene Systemkombinationen zu definieren.

Jenkins	GitHub Actions
`axis`	`strategy/matrix` `context`
`stages`	`steps-context`
`excludes`	Keine

Schritte verwenden, um Aufgaben auszuführen

Jenkins gruppiert Schritte (steps) in Phasen (stages). Jeder dieser Schritte kann unter anderem ein Skript, eine Funktion oder ein Befehl sein. Ebenso verwendet GitHub Actionsjobs, um bestimmte Gruppen von steps auszuführen.

Jenkins	GitHub Actions
`steps`	`jobs.<job_id>.steps`

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

GitHub Actions Workflow mit `cron`

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

Weitere Informationen zu schedule-Ereignissen und zur akzeptierter Cron-Syntax findest du unter Ereignisse zum Auslösen von Workflows.

Umgebungsvariablen in einer Pipeline konfigurieren

Jenkins-Pipeline mit einer Umgebungsvariablen

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

GitHub Actions Workflow mit einer Umgebungsvariable

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

Von Upstream-Projekten ausgehend bauen

Jenkins-Pipeline, die aus einem Upstream-Projekt erstellt wird

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

GitHub Actions Workflow, der aus einem upstream-Projekt erstellt wird

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

Mit mehreren Betriebssystemen bauen

Jenkins-Pipeline, die mit mehreren Betriebssystemen erstellt wird

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

GitHub Actions Workflow, der mit mehreren Betriebssystemen erstellt wird

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@v6
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm install -g bats
      - run: bats tests
        working-directory: ./scripts/myapp

In diesem Artikel