Skip to content

Untyped changelog fragments are silently left out of CHANGELOG.md #2314

Open

Description

@MaxGhenis

Towncrier only consumes fragments named <name>.<type>.md, with a type configured under [[tool.towncrier.type]] in pyproject.toml (breaking, added, changed, fixed, removed). Any other file in changelog.d/ is never written to CHANGELOG.md and never deleted, and nothing tells the author.

Checked on main at 6d89338 (2026-10-11):

Also, towncrier silently drops an empty fragment. A fragment that starts with - renders as - - because the default template adds the bullet; docs/engineering/skills/github-prs.md shows that form in its example (#2162 item 3).

Fix:

  1. A pull-request check that fails when a PR adds or modifies a file in changelog.d/ that towncrier would not consume as <slug>.<type>.md with a configured type, or an empty fragment.
  2. Delete the 93 stale untyped files, after checking that each one's PR is merged and released.
  3. bump_version.py counts only the fragments towncrier consumes, and warns about the rest.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions