Skip to content

Validate entries against omit_pr and omit_author - #32

Merged
zedoraps merged 3 commits into
mainfrom
topic/validate-omitted-metadata
Jul 3, 2026
Merged

Validate entries against omit_pr and omit_author#32
zedoraps merged 3 commits into
mainfrom
topic/validate-omitted-metadata

Conversation

@zedoraps

@zedoraps zedoraps commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

🔍 Problem

  • omit_pr: true / omit_author: true only guard the add command.
  • Entries written directly to disk (e.g. by agents) bypass the options entirely, so prs/authors metadata slips into projects that forbid it.
  • Concrete fallout: platform-internal sets omit_pr: true, yet published entries carry PR numbers that render as 404 links to the public repo.

🛠️ Solution

  • validate now errors on entries carrying prs metadata when the config sets omit_pr: true, and authors metadata when it sets omit_author: true.
  • Applies to unreleased and released entries, and to nested modules via their own configs.

💬 Review

  • Projects that enabled the options after entries were already published will start failing validation until the offending fields are scrubbed — intentional, since those fields violate the config's stated policy.
  • Composes with the new require_pr option from Require PR metadata for changelog entries #34, which already skips its check when omit_pr is set.
📚 Docs PR: tenzir/content#80
📎 Related: #33

zedoraps and others added 2 commits July 1, 2026 22:43
Entries written directly to disk could carry 'prs' or 'authors' metadata
even when the project config sets 'omit_pr: true' or 'omit_author: true',
because those options only guard the 'add' command. The 'validate' command
now reports an error for such entries.

Co-Authored-By: Claude Fable 5 <[email protected]>
@zedoraps
zedoraps merged commit b027b7d into main Jul 3, 2026
9 checks passed
@zedoraps
zedoraps deleted the topic/validate-omitted-metadata branch July 3, 2026 12:22
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.

2 participants