From d1a3cc2d01fe62e9b77a60d8b71386e74c4bf48d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Csaba=20Attila=20Bir=C3=B3?= Date: Sat, 28 Mar 2026 00:06:17 +0100 Subject: [PATCH 1/2] docs: add workflow comparison section to README Compare Gitflow vs GitHub Flow vs Trunk-Based with a decision guide for when to use (and not use) this workflow. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 889672c..0cba34c 100644 --- a/README.md +++ b/README.md @@ -180,6 +180,30 @@ feat!: drop support for Node 16 See [SKILL.md](SKILL.md) for the full specification including commit types, breaking change conventions, versioning rules, release processes, and the complete forbidden operations list. +## Why This Workflow? + +| Aspect | This Skill (Gitflow) | GitHub Flow | Trunk-Based | +|--------|---------------------|-------------|-------------| +| **Branches** | `main` + `develop` + typed branches | `main` + feature branches | `main` only | +| **Releases** | Explicit release branches with version bump | Deploy from main on merge | Continuous deploy from main | +| **Commit style** | Conventional Commits (enforced) | Free-form | Free-form | +| **Merge strategy** | `--no-ff` merge commits (preserves topology) | Squash merge (flat history) | Squash or rebase | +| **Traceability** | Issue → branch → PR → changelog | PR-based | Commit-based | +| **Best for** | Versioned releases, libraries, skills, APIs | SaaS with continuous deploy | Small teams, rapid iteration | + +### When to use Gitflow + +- You ship **discrete versions** (v1.0, v1.1, v2.0) rather than continuous deploys +- You need a **clear audit trail** from issue to release +- Multiple features develop **in parallel** with different release timelines +- You want **hotfix capability** without disrupting in-progress work + +### When NOT to use Gitflow + +- You deploy to production on every merge (GitHub Flow is simpler) +- You have a single developer with no parallel work streams +- Your project doesn't use semantic versioning + ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. From 226e5b3b2dec3ddfe2517d68deae4addfe784147 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Csaba=20Attila=20Bir=C3=B3?= Date: Sat, 28 Mar 2026 00:08:12 +0100 Subject: [PATCH 2/2] fix(ci): upgrade GitHub Actions to Node.js 24 compatible versions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update actions/checkout v4 → v5 and actions/github-script v7 → v8 to resolve Node.js 20 deprecation warning. Also update the reference workflow in SKILL.md. --- .github/workflows/close-linked-issues.yml | 2 +- .github/workflows/lint.yml | 2 +- SKILL.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/close-linked-issues.yml b/.github/workflows/close-linked-issues.yml index e51924b..c141fff 100644 --- a/.github/workflows/close-linked-issues.yml +++ b/.github/workflows/close-linked-issues.yml @@ -30,7 +30,7 @@ jobs: pull-requests: read steps: - name: Close linked issues - uses: actions/github-script@v7 + uses: actions/github-script@v8 with: github-token: ${{ secrets.GITHUB_TOKEN }} script: | diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 90ee780..ace2ea8 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -9,7 +9,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v5 - name: Run lint run: ./scripts/lint.sh diff --git a/SKILL.md b/SKILL.md index 7ed323a..a9c952d 100644 --- a/SKILL.md +++ b/SKILL.md @@ -225,7 +225,7 @@ jobs: pull-requests: read steps: - name: Close linked issues - uses: actions/github-script@v7 + uses: actions/github-script@v8 with: github-token: ${{ secrets.GITHUB_TOKEN }} script: |