Skip to content

ci: fix release changelog documentation checks - #27

Merged
m4sh-wacker merged 1 commit into
mainfrom
ci/fix-release-documentation-quality
Nov 22, 2026
Merged

m4sh-wacker merged 1 commit into
mainfrom
ci/fix-release-documentation-quality

Conversation

@m4sh-wacker

Copy link
Copy Markdown
Collaborator

What this changes

The pinned Release Please parser reads a Conventional Commit from the body of a merge commit as well as from the original commit. PRs #25 and #26 each contributed the same fix twice to the pending changelog in #19.

  • Generate notes using the installed version from the existing action’s lockfile. Collapse repeated notes from the same PR and prefer the source commit link. Keep distinct fixes, breaking notes, issue references and changes in other PRs. The PR template documents the squash-merge convention.
  • Emit dash lists, a single blank line between blocks and inline-code labels for commit hashes. Aspell previously read the end of 25e50ae as the word ae. The changelog alone has a line-length exception for generated links.
  • Check the exact pending comparison against the real base commit until its release tag exists. Published comparisons and other links receive their ordinary checks. Retry transient HTTP failures with bounded concurrency.
  • Exercise the pinned generator in Documentation Quality CI with a real merge/source pair, successive releases, a historical section, breaking notes and issue links.

Verification

  • Reproduced the original four entries using Git history and GitHub PR associations. A read-only Release Please preview selected chore(release): OWASP DecodeBox v0.1.1 #19 and produced two source-linked fixes in both the PR body and changelog. The historical changelog remained intact. The earlier documentation/CI-only range produced no release candidate.
  • Markdown lint, PySpelling/Aspell and Lychee passed for ordinary documentation and the regenerated changelog. Negative controls caught a long README line, invalid changelog spacing and bullets, a misspelling and an unrelated 404.
  • All 1,213 application tests passed. ESLint, TypeScript, both production builds, workflow syntax and the release-note regression passed locally.

After this change reaches main, its Release Please workflow can regenerate #19. This review PR changes documentation and release tooling only.

@m4sh-wacker
m4sh-wacker merged commit 9329faa into main Nov 22, 2026
9 checks passed
@m4sh-wacker
m4sh-wacker deleted the ci/fix-release-documentation-quality branch November 22, 2026 03:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant