[MED] docs: README quick-start `release.yml` omits the load-bearing `paths-ignore` guard (#139 self-cancel) #198

New issue

Closed

opened 2026-06-27 15:26:26 +02:00 by shipwright · 0 comments

shipwright commented

2026-06-27 15:26:26 +02:00

Owner

Filed from the #157 consumer-walkthrough audit (report, finding M1).

Problem

docs/integration.md L198 includes in its release.yml example:

on:
  push:
    branches: [main]
    paths-ignore: ['.release-toolkit-manifest.json']  # #139: skip the cut path's own
                                                       # manifest commit so it doesn't fire
                                                       # a new run + cancel the in-flight cut.

with an explicit note that omitting it makes the cut's own manifest commit fire a new run that cancels the in-flight cut.

The README.md quick-start release.yml example (L97–116) omits paths-ignore entirely. A fresh adopter who follows the README quick-start (the shorter, more-likely first-read path) ships a release.yml that can self-cancel its own cut.

Fix

Add the paths-ignore: ['.release-toolkit-manifest.json'] line (with the #139 rationale, or at least a one-line "required — see integration.md") to the README quick-start example so the two surfaces agree on the load-bearing trigger config.

Refs

#139 (the self-cancel guard this line provides)
#157 (this audit)

Filed from the #157 consumer-walkthrough audit ([report](https://git.frankenbit.de/frankenbit/release-toolkit/issues/157#issuecomment-75472), finding **M1**). ## Problem `docs/integration.md` L198 includes in its `release.yml` example: ```yaml on: push: branches: [main] paths-ignore: ['.release-toolkit-manifest.json'] # #139: skip the cut path's own # manifest commit so it doesn't fire # a new run + cancel the in-flight cut. ``` with an explicit note that omitting it makes the cut's own manifest commit fire a new run that **cancels the in-flight cut**. The `README.md` quick-start `release.yml` example (L97–116) **omits `paths-ignore` entirely**. A fresh adopter who follows the README quick-start (the shorter, more-likely first-read path) ships a `release.yml` that can self-cancel its own cut. ## Fix Add the `paths-ignore: ['.release-toolkit-manifest.json']` line (with the `#139` rationale, or at least a one-line "required — see integration.md") to the README quick-start example so the two surfaces agree on the load-bearing trigger config. ## Refs - #139 (the self-cancel guard this line provides) - #157 (this audit)

shipwright referenced this issue from a commit

2026-06-27 15:27:57 +02:00

docs(walkthrough): fresh-eyes consumer-adoption audit (#157)

shipwright referenced this issue

2026-06-27 15:28:26 +02:00

docs(walkthrough): fresh-eyes consumer-adoption audit (#157) #200