Aller au contenu
FerrFlow

Getting Started / Démarrage rapide

Démarrage rapide

  1. Générer la configuration

    Exécutez ferrflow init à la racine de votre repository. Il détecte vos fichiers de version et génère un fichier .ferrflow :

    Fenêtre de terminal
    ferrflow init

    Pour un projet Rust, cela produit :

    {
    "$schema": "https://ferrflow.com/schema/ferrflow.json",
    "workspace": {
    "tagTemplate": "v{version}"
    },
    "package": [
    {
    "name": "my-app",
    "path": ".",
    "changelog": "CHANGELOG.md",
    "versionedFiles": [
    { "path": "Cargo.toml", "format": "toml" }
    ]
    }
    ]
    }
  2. Prévisualiser le résultat

    Avant de toucher à quoi que ce soit, lancez un dry-run pour voir ce que FerrFlow ferait :

    Fenêtre de terminal
    ferrflow check

    Sortie :

    Scanning . ...
    → feat: add user authentication
    → fix: correct pagination offset
    Bump my-app 0.1.0 → 0.2.0
    Tag v0.2.0
  3. Lancer la release

    Fenêtre de terminal
    ferrflow release

    FerrFlow va :

    • Mettre à jour Cargo.toml à 0.2.0
    • Compléter CHANGELOG.md
    • Committer les changements
    • Créer et pousser v0.2.0
    • Créer une release GitHub (si GITHUB_TOKEN est défini)