Automatischer Build und Release mit GitLab

Diese Anleitung konzentriert sich auf GitLab CI, aber Sie können sie mit kleinen Anpassungen auf jede andere CI/CD-Plattform übertragen.

Vorwort

Stellen Sie sicher, dass Sie Ihre App zuerst zu Capgo hinzugefügt haben, diese Anleitung konzentriert sich nur auf die Upload-Phase.

Commit-Konvention

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

GitLab CI für Tags

Dann müssen Sie Ihr erstes GitLab 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 für jeden 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 nicht haben, sie wird für Sie erstellt.

Damit dies funktioniert, erstellen Sie einen PERSONAL_ACCESS Token in Ihren GitHub Secrets als PERSONAL_ACCESS_TOKEN.

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

Wenn Sie den Token erstellen, wählen Sie als Ablaufdatum never und als Scope repo.

Damit das Tool schließlich versteht, wo Ihre Version gespeichert ist, müssen Sie die Datei cz.toml im Wurzelverzeichnis Ihres Repositories erstellen.

Und fügen Sie dies hinzu:

[tool.commitizen]
name = "cz_conventional_commits"
tag_format = "$major.$minor.$patch$prerelease"
version = "0.11.5"
version_files = [
    "package.json:version",
    ".cz.toml"
]

Setzen Sie die Version in dieser Datei auf die gleiche wie in Ihrer package.json Datei.

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

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

GitHub Actions für 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 sie an Capgo gesendet werden.

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

Damit dies funktioniert, müssen Sie Ihren API-Schlüssel für Capgo holen und ihn in den Secrets Ihres GitHub Repositories als CAPGO_TOKEN hinzufügen.

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

Der Commit 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.