Triggers de pipeline

FerrFlow fonctionne avec n’importe quelle strategie de declenchement CI. Cette page couvre les patterns les plus courants, quand les utiliser, et comment ils interagissent avec releaseCommitMode.

Push sur main

La configuration la plus simple : executer ferrflow release a chaque push sur la branche par defaut. FerrFlow determine si une release est necessaire en se basant sur les commits depuis le dernier tag.

name: Release

on:
  push:
    branches: [main]

jobs:
  release:
    runs-on: ubuntu-latest
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
          token: ${{ secrets.FERRFLOW_TOKEN }}

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

Quand l’utiliser : La plupart des projets. Simple, previsible, entierement automatise.

Compromis : Chaque push sur main declenche un workflow, meme si aucune release n’est necessaire. FerrFlow se termine rapidement quand il n’y a pas de commits a releaser.

Compatible avec : releaseCommitMode: commit (par defaut) ou none.

Declenchement par tag

Executez votre pipeline de build/deploiement quand FerrFlow cree un nouveau tag. Cela separe l’etape de release (tagging) des etapes en aval (build, publication, deploiement).

name: Build & Publish

on:
  push:
    tags:
      - 'v*'          # single-repo: v1.2.0
      - '*@v*'        # monorepo: api@v1.2.0, site@v0.5.1

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Extraire la version du tag
        id: version
        run: |
          TAG="${GITHUB_REF_NAME}"
          VERSION="${TAG##*v}"
          echo "tag=$TAG" >> "$GITHUB_OUTPUT"
          echo "version=$VERSION" >> "$GITHUB_OUTPUT"

      - name: Build
        run: echo "Building version ${{ steps.version.outputs.version }}"

Quand l’utiliser : Quand vous voulez decoupler le versioning du build/deploiement. Courant pour les builds Docker, la publication npm ou les releases binaires.

Compromis : Necessite deux workflows : un pour la release (push-to-main) et un pour le build en aval (tag-triggered). Ajoute quelques secondes de latence.

Monorepo : builds par package

Dans un monorepo, utilisez les patterns de tags pour ne builder que le package concerne :

name: Build Package

on:
  push:
    tags:
      - 'api@v*'
      - 'site@v*'

jobs:
  build-api:
    if: startsWith(github.ref_name, 'api@v')
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - run: echo "Building API ${{ github.ref_name }}"

  build-site:
    if: startsWith(github.ref_name, 'site@v')
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - run: echo "Building site ${{ github.ref_name }}"

Declenchement par release

Executez un pipeline quand une GitHub Release est publiee. Fonctionne bien avec le flag --draft de FerrFlow : FerrFlow cree une release brouillon, vous la reviewez, puis la publication declenche le build.

name: Deploy

on:
  release:
    types: [published]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          ref: ${{ github.event.release.tag_name }}

      - name: Deploy
        run: echo "Deploying ${{ github.event.release.tag_name }}"

Quand l’utiliser : Quand vous voulez une etape de revue manuelle avant le deploiement. Creez des releases brouillon avec ferrflow release --draft, reviewez le changelog, puis publiez.

Compromis : Ajoute une etape manuelle. La release brouillon doit etre publiee avant que le deploy ne se lance.

Manuel (workflow_dispatch)

Declenchez une release a la demande avec un flag dry-run optionnel.

name: Release

on:
  workflow_dispatch:
    inputs:
      dry_run:
        description: 'Dry run (pas de tags, pas de commits, pas de releases)'
        type: boolean
        default: false

jobs:
  release:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
          token: ${{ secrets.FERRFLOW_TOKEN }}

      - uses: FerrLabs/ferrflow@v2
        with:
          args: ${{ inputs.dry_run == true && '--dry-run' || '' }}
        env:
          GITHUB_TOKEN: ${{ secrets.FERRFLOW_TOKEN }}

Quand l’utiliser : Equipes qui preferent des decisions de release explicites. Aussi utile comme workflow secondaire pour des releases ad-hoc.

Base sur une PR

Utilisez releaseCommitMode: pr pour que FerrFlow ouvre une pull request avec le bump de version au lieu de committer directement.

{
  "workspace": {
    "releaseCommitMode": "pr"
  }
}

name: Release

on:
  push:
    branches: [main]

jobs:
  release:
    runs-on: ubuntu-latest
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    permissions:
      contents: write
      pull-requests: write
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
          token: ${{ secrets.FERRFLOW_TOKEN }}

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

Quand l’utiliser : Quand vous voulez reviewer les bumps de version, ou quand la protection de branche empeche les push directs sur main.

Resume

Trigger	Automatique	Gate de revue	Ideal pour
Push sur main	Oui	Non	La plupart des projets
Tag-triggered	Oui	Non	Build/deploy decouples
Release-triggered	Non	Oui	Brouillon, revue, publication
Manuel	Non	Oui	Cadence de release controlee
Base sur PR	Partiel	Oui	Protection de branche / revue