Inhalt der Doku
github-workflows · Doku
Node.js Docker CI/CD
Wiederverwendbarer Workflow für Test, Build, Release, Multi-Arch-Docker-Image in GHCR, Deployment per Dockhand und Meldung an Home Assistant.
node-docker.yml ist der
komplette Ablauf für ein Node.js-Projekt, das als Docker-Container läuft. Er besteht aus drei Jobs.
Ablauf
- publish
- Checkt das Repository mit voller Historie aus und richtet Node.js mit npm-Cache ein.
- Führt
npm ci,npm run test --if-presentundnpm run build --if-presentaus. - Auf
mainodermaster:npm run semantic-release --if-present. - Zeigt der aktuelle Commit auf den Tag
v<version>aus derpackage.json, entstand in diesem Lauf also ein Release, baut er ein Image fürlinux/amd64undlinux/arm64aus demDockerfileund schiebt es nachghcr.io/<owner>/<repo>mit den Tags<major>,<major>.<minor>,<version>undlatest.
- deploy – nur wenn ein Image veröffentlicht wurde und
deployauftruesteht: aktualisiert den Container in der angegebenen Dockhand-Umgebung auf das neuelatest-Image, siehe Dockhand Update. - notify – läuft immer und meldet das Ergebnis an Home Assistant, siehe Home Assistant Notification. Ein übersprungenes Deployment zählt als Erfolg.
Voraussetzungen im Projekt
package.jsonmitversionund einepackage-lock.json- ein npm-Script
semantic-releasesamt Konfiguration, wenn Releases entstehen sollen - ein
Dockerfileim Wurzelordner - optional die npm-Scripts
testundbuild
Aufruf
name: CI/CD
on:
push:
branches: [ main ]
workflow_dispatch:
permissions:
contents: write
packages: write
issues: write
pull-requests: write
jobs:
pipeline:
uses: DasRed/github-workflows/.github/workflows/node-docker.yml@v1
secrets:
dockhand-host: ${{ secrets.DOCKHAND_HOST }}
dockhand-token: ${{ secrets.DOCKHAND_TOKEN }}
homeassistant-webhook-url: ${{ secrets.HOMEASSISTANT_WEBHOOK_URL }}
with:
environment: production
container-name: my-containerWichtig
Die permissions im aufrufenden Workflow sind nötig. Sie begrenzen, was der GITHUB_TOKEN im wiederverwendbaren
Workflow darf: Schreibrechte für Tags und Releases, Pakete für das Image, Issues und Pull Requests für die
Kommentare von semantic-release.
Inputs
| Name | Typ | Pflicht | Standard | Beschreibung |
|---|---|---|---|---|
environment |
string | ja | Name der Dockhand-Umgebung für das Deployment | |
container-name |
string | nein | Name des Repos | Name des Containers, der aktualisiert wird |
node-version |
string | nein | 26 |
Node.js-Version für Installation, Test und Build |
deploy |
boolean | nein | true |
false veröffentlicht nur das Image |
Secrets
| Name | Pflicht | Beschreibung |
|---|---|---|
dockhand-host |
ja | Basis-URL des Dockhand-Servers, z. B. https://dockhand.example.com |
dockhand-token |
ja | API-Token für Dockhand |
homeassistant-webhook-url |
ja | Vollständige URL des Home-Assistant-Webhooks |
Outputs
| Name | Beschreibung |
|---|---|
released |
true, wenn der Lauf ein Release erzeugt und das Image veröffentlicht hat, sonst false |
version |
Version des Releases aus der package.json, leer ohne Release |
image |
Name des Images ohne Tag, z. B. ghcr.io/owner/repo |
Damit können weitere Jobs auf ein Release reagieren, z. B. MCP Registry Publish.
Gut zu wissen
- Kein Release, kein Image. Commits ohne
feat:,fix:oderperf:erzeugen kein Release, also auch kein Image und kein Deployment. Der Lauf ist trotzdem grün. environmentund alle Secrets sind Pflicht, auch mitdeploy: false. Die Meldung an Home Assistant lässt sich nicht abschalten.- Runner: Alle Jobs laufen auf
ubuntu-26.04. - Cache: Der Docker-Build nutzt den GitHub-Actions-Cache (
type=gha), das beschleunigt Folge-Builds deutlich.