Automatisation de la construction et de la mise en production avec Gitlab

Cet article se concentre sur le CI GitLab, mais vous pouvez l'adapter avec un petit ajustement à tout autre plateforme CI/CD.

Avant-propos

Assurez-vous d'avoir ajouté votre application en premier lieu à Capgo, cet article se concentre uniquement sur la phase d'importation.

Convention de commit

Commencez par suivre la convention de commit commits conventionnels`

commits conventionnels

GitLab CI pour tag

Ensuite, vous devez créer votre premier GitLab pour construire automatiquement et créer un tag. .github/workflows/bump_version.yml

Créez un fichier à cette emplacement :

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@v6
        with:
          fetch-depth: 0
          filter: blob:none
          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

avec ce contenu : CHANGELOG.md.

Cela libèrera un tag pour chaque commit dans votre branch principale. Et ajoutera une entrée de changelog pour chaque commit dans la branch principale dans

N'ayez pas peur si vous n'avez pas ce fichier, il vous sera créé. Pour que cela fonctionne, créez un et ajoutez-l’à vos variables GitLab CI/CD comme PERSONAL_ACCESS_TOKEN.

Cela est nécessaire pour permettre au CI de soumettre le changelog.

Lorsque vous créez le jeton, choisissez l'expiration comme never et le champ d'accès comme repo.

Enfin, pour permettre à l'outil de comprendre où votre version est sauvegardée, vous devez créer le fichier .cz.toml à la racine de votre dépôt.

Et ajoutez ceci à l'intérieur :

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

Fixez la version dans ce fichier comme celle que vous avez dans votre package.json fichier.

Cela n'est nécessaire que la première fois, puis les outils maintiendront à jour.

Vous pouvez maintenant soumettre ces deux fichiers et voir votre premier tag apparaitre dans GitHub!

GitHub actions pour la construction

Créez un fichier à ce chemin : .github/workflows/build.yml

avec ce contenu :

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@v6
      - 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 }} # Example 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

Cela installe et construit votre dépendance avant de l'envoyer à Capgo.

Si votre commande de build est différente, vous pouvez la modifier dans l'étape. build_code Pour que cela fonctionne, vous devez obtenir votre clé __CAPGO_KEEP_0__ pour __CAPGO_KEEP_1__, l'ajouter dans le secret de votre repository __CAPGO_KEEP_0__

To make this work, you need to get your API key for Capgo, add it in the Vous pouvez maintenant commiter ces deux fichiers et voir votre premier tag apparaitre dans GitHub ! La mise à jour du commit générera une nouvelle build pour le canal de production. CAPGO_TOKEN.

Vous devriez ajouter vos tests dans l'étape de build pour vous assurer que votre GitHub fonctionne.

Allez à votre tableau de bord __CAPGO_KEEP_0__ et vérifiez votre build qui vient d'apparaître, vous avez maintenant votre système CI/CD.

You should add your test in the build step to ensure your code is working.

Vous devriez ajouter vos tests dans l'étape de build pour vous assurer que votre Capgo fonctionne.

Si vous souhaitez que tous vos utilisateurs reçoivent la mise à jour dès qu'elle est disponible, allez dans votre canal et définissez-le sur public.

Continuez de Automatic build and release with Gitlab

Si vous utilisez Automatic build and release with Gitlab pour planifier l'automatisation de CI/CD, connectez-l’à Capgo CI/CD pour le flux de workflow du produit dans Capgo CI/CD, Capgo Native Builds pour le flux de workflow du produit dans Capgo Native Builds, Capgo Integrations for the product workflow in Capgo Integrations, pour le flux de workflow du produit dans __CAPGO_KEEP_0__ Integrations,  pour les détails d'implémentation dans l'intégration CI/CD, et GitHub Intégration d'actions pour les détails d'implémentation dans GitHub Intégration d'actions.