GitHub Actions

Utiliser l’action officielle

La manière la plus simple d’utiliser FerrFlow dans GitHub Actions est l’action FerrLabs/ferrflow@v2. Elle installe le binaire et exécute ferrflow release automatiquement.

name: Release

on:
  push:
    branches: [main]

jobs:
  release:
    runs-on: ubuntu-latest
    permissions:
      contents: write   # requis pour pousser les tags et créer les releases
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0          # historique complet nécessaire pour le scan des commits
          token: ${{ secrets.GITHUB_TOKEN }}

      - uses: FerrLabs/ferrflow@v2
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Attention

fetch-depth: 0 est requis. Sans cela, FerrFlow ne peut pas trouver les tags précédents et traitera chaque commit comme nouveau.

Permissions

FerrFlow a besoin de contents: write pour :

• Pousser les commits de bump de version
• Créer et pousser les tags git
• Créer les GitHub Releases

Si votre repository a des règles de protection de branche, créez un token dédié avec les permissions nécessaires et passez-le via FERRFLOW_TOKEN ou configurez l’input token de l’action.

Accéder à la sortie de la release

L’action expose la nouvelle version en output que vous pouvez utiliser dans les étapes suivantes :

- uses: FerrLabs/ferrflow@v2
  id: ferrflow
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Build Docker image
  if: steps.ferrflow.outputs.version != ''
  run: |
    docker build -t myimage:${{ steps.ferrflow.outputs.version }} .
    docker push myimage:${{ steps.ferrflow.outputs.version }}

Skip CI sur les commits de release

FerrFlow ajoute [skip ci] dans le message des commits de version par défaut pour éviter les boucles infinies. Aucune configuration supplémentaire nécessaire.

Commentaires de preview sur les PR

FerrFlow peut poster un commentaire sur chaque pull request montrant quelles versions seront bump\u00e9es au merge. Le commentaire est mis \u00e0 jour automatiquement \u00e0 chaque push.

.github/workflows/preview.yml

name: FerrFlow Preview

on:
  pull_request:

permissions:
  contents: read
  pull-requests: write

jobs:
  preview:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
      - uses: FerrLabs/ferrflow@v2
        with:
          mode: preview
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Si aucun changement publiable n’est d\u00e9tect\u00e9, le commentaire l’indique.

Exemple monorepo

Dans un monorepo, FerrFlow publie chaque package modifi\u00e9 en une seule ex\u00e9cution :

- uses: FerrLabs/ferrflow@v2
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Cr\u00e9e api@v1.3.0 et site@v0.5.1 en une seule \u00e9tape si les deux ont chang\u00e9