Automatischer Build und Release der App mit GitHub Actions

Dieser Tutorial konzentriert sich auf das GitHub-Hosting, aber Sie können ihn mit kleinen Anpassungen an jede andere CI/CD-Plattform anpassen.

Vorwort

Stellen Sie sicher, dass Sie Ihre Capacitor-App zuerst zu Capgo hinzugefügt haben. Dieser Tutorial konzentriert sich nur auf die Upload-Phase. Wenn Sie Ihre App zu Capgo hinzufügen müssen, können Sie diesem Tutorial folgen.

Commit-Konvention

Zunächst müssen Sie beginnen, der Commit-Konvention conventional commits zu folgen. Dies wird den Tools helfen zu verstehen, wie die Versionsnummer erhöht werden soll. Es dauert nur 5 Minuten, es zu erlernen.

GitHub-Actions für Tags

Dann müssen Sie Ihre erste GitHub-Action erstellen, um automatisch zu bauen und Tags zu erstellen.

Erstellen Sie eine Datei unter diesem Pfad: .github/workflows/bump_version.yml

mit diesem Inhalt:

name: Bump version

on:
  push:
    branches:
      - main

jobs:
  bump-version:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    runs-on: ubuntu-latest
    name: "Bump version and create changelog with standard version"
    steps:
      - name: Check out
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          token: '${{ secrets.PERSONAL_ACCESS_TOKEN }}'
      - name: Git config
        run: |
          git config --local user.name "github-actions[bot]"
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
      - name: Create bump and changelog
        run: npx capacitor-standard-version
      - name: Push to origin
        run: |
          CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
          remote_repo="https://${GITHUB_ACTOR}:${{ secrets.PERSONAL_ACCESS_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git"
          git pull $remote_repo $CURRENT_BRANCH
          git push $remote_repo HEAD:$CURRENT_BRANCH --follow-tags --tags

Dies wird bei jedem Commit in Ihrem Hauptzweig einen Tag erstellen und für jeden Commit im Hauptzweig einen Changelog-Eintrag in CHANGELOG.md hinzufügen.

Machen Sie sich keine Sorgen, wenn Sie diese Datei noch nicht haben, sie wird für Sie erstellt.

Um dies zum Laufen zu bringen, erstellen Sie ein PERSONAL_ACCESS Token in Ihren GitHub Secrets als PERSONAL_ACCESS_TOKEN.

Dies ist notwendig, damit die CI den Changelog committen kann.

Wenn Sie das Token erstellen, wählen Sie als Ablaufdatum never und als Umfang repo.

Setzen Sie zuletzt die Version in Ihrer package.json Datei, synchronisieren Sie sie mit Ihrer nativen Versionsnummer, das wird den nächsten Schritt erleichtern.

Dies ist nur beim ersten Mal notwendig, danach werden die Tools es aktuell halten.

Sie können jetzt diese beiden Dateien committen und Ihren ersten Tag in GitHub erscheinen sehen!

Sowohl die native als auch die Web-Plattform werden die Versionsnummer nach jedem Commit erhöhen.

GitHub-Actions für den Build

Erstellen Sie eine Datei unter diesem Pfad: .github/workflows/build.yml

mit diesem Inhalt:

name: Build source code and send to Capgo

on:
  push:
    tags:
      - '*'

jobs:
  deploy:
    runs-on: ubuntu-latest
    name: "Build code and release"
    steps:
      - name: Check out
        uses: actions/checkout@v4
      - name: Install dependencies
        id: install_code
        run: npm i
      - name: Build
        id: build_code
        run: npm run build
        env: # Remove both lines  if you don't need it
          FIREBASE_CONFIG: ${{ secrets.FIREBASE_CONFIG }} # Exemple of env var coming from a secret
      - name: Create Release
        id: create_release
        run: npx @capgo/cli@latest bundle upload -a ${{ secrets.CAPGO_TOKEN }} -c production

Dies wird Ihre Abhängigkeiten installieren und bauen, bevor es an Capgo gesendet wird.

Wenn Ihr Befehl zum Bauen anders ist, können Sie ihn im Schritt build_code ändern.

Um dies zum Laufen zu bringen, müssen Sie Ihren API-Schlüssel für Capgo erhalten und ihn in den Secrets Ihres GitHub-Repositories als CAPGO_TOKEN hinzufügen.

Sie können jetzt diese beiden Dateien committen und Ihren ersten Tag in GitHub erscheinen sehen!

Das Hinzufügen des Commits wird einen neuen Build für den Produktionskanal generieren.

Sie sollten Ihre Tests im Build-Schritt hinzufügen, um sicherzustellen, dass Ihr Code funktioniert.

Gehen Sie zu Ihrem Capgo-Dashboard und überprüfen Sie Ihren Build, der gerade erschienen ist. Sie haben jetzt Ihr CI/CD-System.

Wenn Sie möchten, dass alle Ihre Benutzer das Update erhalten, sobald es verfügbar ist, gehen Sie zu Ihrem Kanal und setzen Sie ihn auf public.

Sie können auch den nativen Build Ihrer Ionic Capacitor JavaScript-App hinzufügen, indem Sie diesem Tutorial folgen 👇