Skip to content

🐛 fix(news): accept bare fragment names - #57

Merged
gaborbernat merged 1 commit into
tox-dev:mainfrom
gaborbernat:fix/bare-fragment-names
Nov 2, 2026
Merged

gaborbernat merged 1 commit into
tox-dev:mainfrom
gaborbernat:fix/bare-fragment-names

Conversation

@gaborbernat

Copy link
Copy Markdown
Member

tox#4371 had to rename a descriptive changelog fragment to its PR number because news validation rejected the bare name. Projects using release-creator can now accept descriptive names without changing their contributor guidance.

Validation checks bare names and catches collisions with their + forms. Before Towncrier builds a release, the fragment linker adds the orphan prefix so the filename does not turn into an issue reference. Projects can adopt this through their next release-tools lock update after publication.

@gaborbernat gaborbernat added the bug Something isn't working label Nov 2, 2026
@read-the-docs-community

read-the-docs-community Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 release-creator | 🛠️ Build #35594919 | 📁 Comparing fd2c6a2 against latest (d4e6d5a)

  🔍 Preview build  

4 files changed
± changelog.html
± how-to/link-fragments.html
± reference/formats.html
± tutorial/first-release.html

Contributor guidance permits descriptive fragment names, but validation
rejected them. Prefix those names before Towncrier builds so they do not
become issue references.
@gaborbernat
gaborbernat force-pushed the fix/bare-fragment-names branch from 204e9b1 to fd2c6a2 Compare November 2, 2026 21:37
@gaborbernat
gaborbernat merged commit b1ae976 into tox-dev:main Nov 2, 2026
14 checks passed
@gaborbernat
gaborbernat deleted the fix/bare-fragment-names branch November 2, 2026 22:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant