Bauen plattformübergreifende CI/CD-Aktionen mit Docker

Letzte Woche wurde ich von Kopfschmerzen getroffen - unser perfekt abgestimmter Lingo.dev Github Actions Workflow konnte nicht auf der Gitlab -Instanz eines Mitwirkenden laufen. Dann wurde mir klar

Also habe ich auf der Suche nach einer plattformübergreifenden CI-Automatisierung geführt, die auf Github, Gitlab und Bitbucket (und möglicherweise auch anderen auch andere!) Läuft. Die Lösung begann als einfache Github -Aktion, entwickelte sich jedoch zu etwas leistungsfähigerem, wenn wir mehrere Code -Hosting -Plattformen unterstützen mussten.

Ich werde Sie durch den genauen Prozess führen:

Einfach anfangen, ich werde zeigen, wie Github -Aktionen
1. funktionieren
2. Niveau zum Erstellen wiederverwendbarer Docker -Bild
3. Endlich werde ich Ihnen zeigen, wie Sie dies auf jeder Plattform ausführen

Befolgen Sie die Schritte, um Ihre erste plattformübergreifende Aktion zu erstellen und zu versenden. Oder mit einem Lesezeichen versehen den Artikel für später.

tl; dr siehe Template Repository ???

1. Einfach beginnen: JavaScript in GitHub -Aktionen ausführen

Ausführen einer Github -Aktion

Beginnen wir mit der einfachsten GitHub -Aktion - eine, die eine JavaScript -Datei ausführt. Erstellen Sie zunächst Index.js im Stamm

console.log("Hello World");

Erstellen Sie nun eine Workflow -Datei .Github/Workflows/hello.yml:

name: Hello World
on:
  push:
    branches:
      - main

jobs:
  hello:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: "20"
      - name: Say Hello
        run: node index.js

Diese Aktion wird:

Auslösen beim Druck auf den Hauptzweig
Schauen Sie sich Ihr Repository
2. an
node.js Umgebung einrichten
Führen Sie Ihr Skript aus

Es wiederverwendbar machen

Lassen Sie uns diese Aktion nun wiederverwendbar machen, indem wir sie in ein separates Repository verschieben. Erstellen Sie mit diesen Dateien ein neues Github-Repository (z. B. Hallo-Welt-Action wie mein Beispiel hier):

Index.js (gleich wie zuvor):

console.log("Hello World");

action.yml:

name: "Hello World Action"
description: "A simple action that says hello"
runs:
  using: "node20"
  main: "index.js"

Jetzt können Sie diese Aktion in jedem Repository verwenden, indem Sie sie in Ihrem Workflow verweisen:

name: Use Hello Action
on:
  push:
    branches:
      - main

jobs:
  hello:
    runs-on: ubuntu-latest
    steps:
      - name: Say Hello
        uses: your-username/hello-world-action@main

Die wichtigsten Unterschiede sind:

Die Aktion lebt in seinem eigenen Repository
action.yml definiert, wie die Aktion
2. ausgeführt wird
Andere Repositories können es verwenden, indem Sie Verwendungszwecke verwendeten: Ihr Nutzungsname/Hello-World-Action@Ref

2. Nivellierung: Dockerized TypeScript -Aktion

Erstellen wir nun eine ausgefeiltere Aktion, die den TypeScript -Code ausführt. Wir benötigen mehrere Dateien:

1. Initialisieren Sie das Projekt und richten Sie Typenkript ein:

   
   

   pnpm init                # Creates package.json
   pnpm add -D typescript   # Install TypeScript as dev dependency
   
   

2. aktualisieren Sie Ihr Paket.json, um das Build -Skript hinzuzufügen:

   
   

   {
     "scripts": {
       "build": "tsc"
     }
   }
   
   

3. benennen Sie dann unseren index.js in idex.ts um, um TypeScript anstelle von JavaScript zu verwenden und in das SRC -Verzeichnis zu verschieben.

4. Erstellen Sie tsconfig.json, um die Typscript -Kompilierung zu konfigurieren:

   
   

   {
     "compilerOptions": {
       "target": "ES2022",
       "module": "commonjs",
       "outDir": "./build",
       "rootDir": "./src",
       "strict": true,
       "esModuleInterop": true,
       "skipLibCheck": true,
       "forceConsistentCasingInFileNames": true
     },
     "exclude": ["node_modules", "build", "**/*.test.ts"]
   }
   
   

5. Erstellen Sie eine Dockerfile:

   
   

console.log("Hello World");

1. definieren Sie die Aktion in action.yml neu:

name: Hello World
on:
  push:
    branches:
      - main

jobs:
  hello:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: "20"
      - name: Say Hello
        run: node index.js

Docker Image lokal ausführen

Um das in Dockerfile definierte Bild vor Ort zu erstellen und auszuführen, benötigen Sie die Docker -Desktop -App. Angenommen, Docker läuft vor Ort, können Sie:

1. Erstellen Sie das Bild:

console.log("Hello World");

1. Führen Sie es aus:

name: "Hello World Action"
description: "A simple action that says hello"
runs:
  using: "node20"
  main: "index.js"

3.. Plattformübergreifende Unterstützung

ist jetzt der interessanteste Teil - Ihre Aktion auf anderen Plattformen ausführt. Wir müssen:

1. Erstellen und drücken Sie unser Docker -Image in eine Registrierung
2. verweisen Sie in plattformspezifischen Konfigurationen

Bauen und Veröffentlichen von Docker -Image

Erstellen Sie zuerst einen Workflow, um das Docker -Bild bei jeder Version zu erstellen und zu schieben. Wir werden die GitHub Container Registry (GHCR) verwenden, die mit Ihrem GitHub geliefert wird (kostenlos für öffentliche Repositories, 500 MB für private Repositories zum freien Plan).

name: Use Hello Action
on:
  push:
    branches:
      - main

jobs:
  hello:
    runs-on: ubuntu-latest
    steps:
      - name: Say Hello
        uses: your-username/hello-world-action@main

Github -Aktionen

Um diese Aktion in GitHub -Aktionen eines anderen Repositorys zu verwenden, erstellen Sie eine Workflow -Datei in .github/Workflows/hello.yml (siehe GitHub -Aktionen Workflow -Syntaxdokumentation):

pnpm init                # Creates package.json
pnpm add -D typescript   # Install TypeScript as dev dependency

Wenn Sie diese Aktion nur auf GitHub -Aktionen ausführen müssen, müssen Sie das Docker -Bild nicht erstellen und schieben. GitHub -Aktionen erstellen den Docker -Container direkt aus der in Ihrer Aktion.YML -Datei angegebenen Dockerfile bei jedem Workflow -Lauf. Dies ist effizienter, da es die zusätzlichen Schritte des Drückens und des Ziehens aus einem Containerregister vermeidet. Wenn Sie diese Aktion jedoch auf anderen CI -Plattformen wie GitLab oder Bitbucket verwenden möchten, müssen Sie das Docker -Bild wie oben gezeigt veröffentlichen.

Der kostenlose Plan von

Github bietet die großzügigste CI/CD -Protokollzuweisung zwischen den drei Plattformen. Es enthält:

• Unbegrenzte Minuten für öffentliche Repositories
• 2.000 Minuten/Monat für private Repositories

GitLab CI -Konfiguration

erstellen .gitlab-ci.yml (siehe GitLab CI/CD-Dokumentation):

{
  "scripts": {
    "build": "tsc"
  }
}

Ihr GitLab -kostenloser Plan enthält 400 CI/CD -Berechnungsprotokoll pro Monat, unabhängig davon, ob das Repository öffentlich oder privat ist.

Bitbucket -Pipelines

bitbucket-pipelines.yml erstellen (siehe Bitbucket-Pipelines-Dokumentation):

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "commonjs",
    "outDir": "./build",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "exclude": ["node_modules", "build", "**/*.test.ts"]
}

Bitbuckets kostenloser Plan beinhaltet nur 50 Build -Minuten pro Monat, unabhängig davon, ob das Repository öffentlich oder privat ist, was die niedrigste freie Stufe aller drei Plattformen macht.

Andere CI/CD -Plattformen

Da wir unser Docker -Image in einer öffentlichen Github -Containerregistrierung veröffentlicht haben, können wir diese auf jeder Plattform ausführen, die Docker -Bilder unterstützt. Dies wird unterstützt von:

• Kreis CI (DOCS)
• Travis ci (docs)

Lassen Sie mich wissen, wenn Sie dies woanders ausführen, ich bin neugierig auf Ihren Anwendungsfall!

---

? Was können Sie damit tun?

Wir haben eine Aktion für die Ausführung von automatisierten Lingo.Dev -Lokalisierung für Ihre Web- und Mobile -Apps auf jeder CI -Plattform erstellt. In jedem Commit aktualisiert es Übersetzungen in Ihrem gesamten Repository mithilfe von lingo.dev localization Engine - entweder als neues Commit oder durch Öffnen einer Pull -Anfrage (DOCS).

Beispiel für GitHub:

console.log("Hello World");

---

Sie können wiederverwendbare Aktionen erstellen und sie einfach in Ihre Workflows integrieren, unabhängig von der von Ihnen verwendeten Code -Hosting -Plattform. Hier sind einige Ideen für Sie:

• plattformübergreifende Testreporter (orchestrieren End-to-End-Testsitzung)
• Benutzerdefinierte Code -Qualitätsprüfer (denken Sie an Formatierung, Linie, Test)
• Versionshinweise Generator (Wie wäre es mit Veröffentlichung eines Changelogs auf Ihrer Website?)

Wofür würden Sie es verwenden?

? Bonus: Vorlage -Repository

Wenn Sie nicht Lust haben, den Rest des Artikels zu lesen, finden Sie hier ein Vorlagen -Starter -Repository mit dem gesamten Code. Es enthält die Aktion - Sie können sie auf Github, Gitlab und Bitbucket ausführen.

https://github.com/mathio/awesome-actionstarter

? Tipp: Klonen Sie das Repo und machen Sie es zu einem Ausgangspunkt für Ihre eigene Aktion:

name: Hello World
on:
  push:
    branches:
      - main

jobs:
  hello:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: "20"
      - name: Say Hello
        run: node index.js

… oder erstellen Sie einfach ein neues Repository aus meiner Vorlage.

implementieren Sie dann einfach Ihre eigene Aktionslogik in src/index.ts Datei.

Abschluss

Wir haben gesehen, wie man sich von einer einfachen Shell-basierten Github-Aktion zu einer ausgeklügelten Typ-Skriptaktion entwickelt, die überall ausgeführt werden kann. Die wichtigsten Imbissbuden sind:

1. Starten Sie einfach mit Shell -Befehlen, um Ihre Automatisierungslogik zu validieren
docerisieren Sie Ihre Aktion, um sie tragbar zu machen
Verwenden Sie Containerregister, um Ihre Aktionen auf Plattformen zu verteilen
Passen Sie die Konfiguration für jede Plattform an, während die Kernlogik in Docker

beibehält

Dieser Ansatz bietet Ihnen die Flexibilität, Ihre Automatisierung überall auszuführen und gleichzeitig eine einzelne Codebasis beizubehalten. Glückliche Automatisierung!

---

Ich poste gelegentlich über technische Sachen und neue Lingo.dev -Funktionen auf Twitter als @mathio28. Lass uns in Kontakt bleiben.

Das obige ist der detaillierte Inhalt vonBauen plattformübergreifende CI/CD-Aktionen mit Docker. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!