Compilazione e Distribuzione Automatica con Gitlab

Questa esercitazione si concentra su GitLab CI, ma puoi adattarla con qualche piccola modifica a qualsiasi altra piattaforma CI/CD

Prefazione

Assicurati di aver prima aggiunto la tua app a Capgo, questa esercitazione si concentra solo sulla fase di caricamento

Convenzione dei commit

Innanzitutto devi iniziare a seguire la convenzione dei commit conventional commits` questo aiuterà gli strumenti a capire come aggiornare il numero di versione, ci vogliono 5 minuti per impararla

GitLab CI per i tag

Poi devi creare il tuo primo GitLab per compilare automaticamente e creare tag

Crea un file in questo percorso: github/workflows/bump_versionyml

con questo contenuto:

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

Questo rilascerà un tag per ogni commit nel tuo ramo principale e aggiungerà una voce di changelog per ogni commit nel ramo principale in CHANGELOGmd

Non preoccuparti se non hai questo file, verrà creato per te

Per farlo funzionare, crea un PERSONAL_ACCESS nei tuoi segreti di GitHub come PERSONAL_ACCESS_TOKEN

Questo è necessario per permettere alla CI di committare il changelog

Quando crei il token, scegli la scadenza come never e l’ambito come repo

Infine, per permettere allo strumento di capire dove è salvata la tua versione, devi creare il file cztoml nella radice del tuo repository

E aggiungere questo all’interno:

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

Imposta la versione in questo file come la stessa che hai nel tuo file packagejson

Questo è necessario solo la prima volta, poi gli strumenti lo terranno aggiornato

Ora puoi committare entrambi i file e vedere apparire il tuo primo tag su GitHub!

GitHub actions per la build

Crea un file in questo percorso: github/workflows/buildyml

con questo contenuto:

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

Questo installerà e compilerà le tue dipendenze prima di inviarle a Capgo

Se il tuo comando per la compilazione è diverso, puoi cambiarlo nel passaggio build_code

Per farlo funzionare, devi ottenere la tua chiave API per Capgo, aggiungila nei segreti del tuo repository GitHub come CAPGO_TOKEN

Ora puoi committare entrambi i file e vedere apparire il tuo primo tag su GitHub!

Aggiungere il commit genererà una nuova build per il canale di produzione

Dovresti aggiungere i tuoi test nella fase di build per assicurarti che il tuo codice funzioni

Vai alla tua dashboard Capgo e controlla la tua build appena apparsa, ora hai il tuo sistema CI/CD

Se vuoi permettere a tutti i tuoi utenti di ottenere l’aggiornamento quando è disponibile, vai al tuo canale e impostalo su public