Skip to content

Teach skill about omit_pr and omit_author options - #33

Merged
zedoraps merged 4 commits into
mainfrom
topic/skill-omit-metadata-guidance
Jul 3, 2026
Merged

Teach skill about omit_pr and omit_author options#33
zedoraps merged 4 commits into
mainfrom
topic/skill-omit-metadata-guidance

Conversation

@zedoraps

@zedoraps zedoraps commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

🔍 Problem

  • The add-changelog-entry skill reference told agents to manually write PR numbers into entry frontmatter after filing a PR — bypassing the omit_pr guard that only exists on the add command.
  • This is exactly how prs metadata ended up in platform-internal entries despite its config setting omit_pr: true, producing 404 PR links on the public changelog.
  • The skill also never ran validate after entry creation, so nothing caught the violation.

🛠️ Solution

  • The PR numbers and authors sections now start with the omission check: when the project config sets omit_pr: true / omit_author: true, record nothing — no flags, no manual frontmatter edits. The guidance covers both config.yaml and the package.yaml fallback.
  • New "Validate" section: run uvx tenzir-ship validate after creating or editing an entry.

💬 Review

📎 Related: #32

zedoraps and others added 3 commits July 1, 2026 22:44
The add-changelog-entry reference instructed agents to manually write PR
numbers into entry frontmatter after filing a PR, bypassing the omit_pr
guard on the add command. Respect omit_pr and omit_author when set, and
run validate after creating or editing an entry.

Co-Authored-By: Claude Fable 5 <[email protected]>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5d23c39ac2

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread skills/tenzir-ship/references/add-changelog-entry.md
Comment thread skills/tenzir-ship/references/add-changelog-entry.md Outdated
Package-mode changelogs without a config.yaml load omit_pr and
omit_author from the adjacent package.yaml, so checking only
config.yaml would miss the setting.

Co-Authored-By: Claude Fable 5 <[email protected]>
@zedoraps
zedoraps merged commit 8407755 into main Jul 3, 2026
9 checks passed
@zedoraps
zedoraps deleted the topic/skill-omit-metadata-guidance branch July 3, 2026 02:01
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