Gestionar el desarrollo y la construcción de producción con GitHub actions

Dieses Tutorial konzentriert sich auf das GitHub-Hosting, aber Sie können es mit kleinen Anpassungen auf jede andere CI/CD-Plattform übertragen.

Vorwort

Stellen Sie sicher, dass Sie Ihre Capacitor-App zuerst zu Capgo hinzugefügt haben, dieses Tutorial 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, es zu lernen.

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
      - development

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
        if: github.ref == 'refs/heads/main'
        run: npx capacitor-standard-version
      - name: Create bump and changelog
        if: github.ref != 'refs/heads/main'
        run: npx capacitor-standard-version --prerelease alpha
      - 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 erstellt einen Tag für jeden Commit in Ihrem main-Branch und eine alpha-Version für development, sowie einen Changelog-Eintrag für jeden Commit in CHANGELOG.md.

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

Damit dies funktioniert, müssen Sie ein PERSONAL ACCESS Token in Ihren GitHub secret als PERSONAL_ACCESS_TOKEN erstellen.

Dies ist notwendig, damit die CI den Changelog und die Versionserhöhung committen kann.

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

Setzen Sie den version-Schlüssel in Ihrer package.json-Datei. Verwenden Sie dafür die letzte im Store veröffentlichte Version.

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

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

capacitor-standard-version ist das Paket, das die Magie bewirkt. Standardmäßig aktualisiert es auch Ihre Versionsnummer in Android und iOS.

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 build
        env:
          MY_ENV_VAR: ${{ secrets.MY_ENV_VAR }}
      - name: Create Release Alpha
        if: "contains(github.ref, '-alpha.')"
        id: create_release_prepro
        run: npx @capgo/cli@latest bundle upload -a ${{ secrets.CAPGO_TOKEN }} -c development
      - name: Create Release Production
        if: "!contains(github.ref, '-alpha.')"
        id: create_release_prod
        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 build_code-Schritt ändern.

Wenn Sie eine Umgebungsvariable benötigen, verwenden Sie MY_ENV_VAR und setzen Sie das secret in Ihren GitHub-Projekteinstellungen, dann secret dann GitHub Action.

Damit der Capgo-Upload 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 Ihre erste Version in Capgo erscheinen sehen!

Der Commit wird einen neuen Capacitor-Build für Produktions- und Entwicklungskanäle generieren.

Sie sollten Ihre Tests im Ionic-Build-Schritt hinzufügen, um sicher zu sein, 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.