Skip to content

verify-release-notes says a (#n) inside an HTML comment still closes the issue - no longer true since release-action v1.4.2 #149

Closed

Description

@woksin

Since Cratis/release-action v1.4.2 (Cratis/release-action#195, Cratis/release-action#205), release-action removes closed HTML comments from the release notes before it creates the release. It also reads the issues to close from those published notes. A (#n) written only inside an HTML comment therefore no longer closes the issue.

The check is still right to fail such a reference, but the reason it gives is now wrong:

  • .github/workflows/verify-release-notes.yml
    • the header comment around lines 68-70: "release-action does NOT ignore them, so a (#n) inside a comment ..."
    • the code comment around line 500: "a (#n) hidden in an HTML comment still closes its issue"
    • the error message around line 687: "the release page does not show the comment, but release-action still closes #n"
  • README.md, around line 464 ("inside an HTML comment fails because release-action would still close it") and line 468 ("a (#n) inside a comment still closes the issue and fails")
  • .github/scripts/tests/verify-release-notes.spec.mjs, around lines 481 and 490 (the test name and the asserted message)

Suggested wording: the reference is removed with the comment, so the issue is not closed. Write (#n) at the end of the delivering bullet, outside the comment. The same text lives in Cratis/AI's cratis-release-notes-reviewed.cjs hook and should change with it.

Status

State: Done — Merged as 96b3eb5; issue closed.
Branch: stage-422-atomic-execution (#207)
Scope: Correct the hidden-(#n) explanation in verify-release-notes (comments, message, README, spec); validation unchanged. Branch workflows-149-hidden-refs.
Delivered: Nothing yet.
Remaining: To be confirmed.
Follow-ups: None.

Activity

  1. woksin commented on Oct 6, 2026

    @woksin
    ContributorAuthor

    The matching corpus text and the cratis-release-notes-reviewed.cjs hook are tracked in Cratis/AI#505; the two should change together.

  2. added theissue type on Oct 6, 2026
  3. self-assigned this
    on Oct 24, 2026
  4. woksin commented on Oct 24, 2026

    @woksin
    ContributorAuthor

    Delivered by #207 (merged as 96b3eb5): verify-release-notes, its embedded copy in verify-pull-request-policy, the README and the spec now say that a (#n) inside an HTML comment closes nothing because release-action removes the comment; the check still fails it. The matching corpus hook text follows in Cratis/AI#505.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions