fix: drop the soothfast bot's own commits from the changelog - #199
Merged
Merged
Conversation
- a consumer's Unreleased section listed the regeneration commits the action lands, whose subjects no library allowlist can know
- a repo that renames the action's bot-slug commits under a different author, which the shipped default would miss
Contributor
soothfast gate |
Verdenroz
added a commit
that referenced
this pull request
Sep 12, 2026
## What changed - Froze the `## Unreleased` heading in `CHANGELOG.md` to `## 0.3.2 - 2026-09-11` and wrote its Overview and Upgrade notes. - Bumped `[workspace.package] version` and the eight `[workspace.dependencies]` requirements from `0.3.1` to `0.3.2`. - Regenerated `Cargo.lock`. Only version lines moved; no dependency was added, removed, or changed. - Bumped the version strings in `README.md` and `soothfast.toml`. ## Why 0.3.1 gave the action its `features` and regeneration inputs, so CI could be told once what a repository needs. A developer running the CLI by hand still repeated the same flags on every invocation, and two defects surfaced once adopters started bumping across versions. This release carries all three fixes: `soothfast.toml` holds the feature and package defaults, the gate stops letting a reference it could not pin decide a verdict quietly, and the changelog drops the bot's own regeneration commits instead of listing the paperwork as changes. Everything here is additive and opt-in. A repository on `soothfast = "0.3"` picks it up without touching its manifest. ## How was this tested - `cargo fmt --all -- --check`: clean. - `cargo clippy --workspace --all-targets -- -D warnings`: clean. - `cargo test --workspace --no-fail-fast`: 817 passed, 4 ignored, 1 failed. The failure is `invoke::tests::a_plain_directory_in_the_repo_is_not_a_worktree_root`, which asserts the workspace root is not a linked git worktree. It fails from any linked-worktree checkout and passes from a plain one, which is what CI uses. Confirmed by running the same built test binary from both. - `cargo check --workspace` after the bump: clean, all ten crates resolve at `0.3.2`. - Read the frozen section against `git log v0.3.1..master`: it lists #195, #196 and #199, and none of the four soothfast-bot regeneration commits. Those exclusions are the filter from #199 running against real history. - `make gate BASE=master` was not run. This commit changes no measured code. ## Checklist - [ ] `make check` passes (fmt, clippy `-D warnings`, `cargo test --workspace`) - [ ] `make gate BASE=master` passes, or any intentional cost change is explained above - [ ] Tests added/updated for new behavior (not required for docs/CI-only changes) - [ ] Public API items have `///` doc comments - [x] No new dependency, or its justification is included above (see [Dependency Policy](../CONTRIBUTING.md#dependency-policy)) - [x] Docs (`README.md`, `docs/`, `soothfast:bind`/`soothfast:claim` markers) updated if behavior changed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
report changelog'sgit logcall, and dropped every commit the soothfast bot wrote before the subjects reach the parser.[changelog] bot-authorinsoothfast.tomland a--bot-author NAMEflag, for a repo that renamed the action'sbot-slug. The flag wins, then the table, then the shippedsoothfast-bot[bot].docs/reports.md, including that it drops exactly one author and leaves every other bot in place.Why
The only guard against bot noise was a list of this repo's own regeneration subjects, which no adopting repo matches. A consumer lands its regenerated artifacts under the title the action sets, so those commits kept showing up in its own Unreleased section under Internal. Author identity is what actually survives a squash merge, and the bot always commits as one fixed name. The filter names that one author and nothing else:
dependabot[bot]writes an entire Dependencies section, and a rule matching every[bot]author would delete it without a trace.How was this tested
cargo test -p cargo-soothfast -p soothfast-report: 233 passed, 1 failed incargo-soothfast; 34 passed, 1 ignored insoothfast-report.invoke::tests::a_plain_directory_in_the_repo_is_not_a_worktree_root, which is cwd-dependent and fails from any linked worktree. This branch does not touchinvoke.rs.cargo fmt --all -- --check: clean.cargo clippy --workspace --all-targets -- -D warnings: clean.dependabot[bot]commit survives the filter.make checkandmake gate BASE=masterwere not run.Checklist
make checkpasses (fmt, clippy-D warnings,cargo test --workspace)make gate BASE=masterpasses, or any intentional cost change is explained above///doc commentsREADME.md,docs/,soothfast:bind/soothfast:claimmarkers) updated if behavior changed