Skip to content

feat: checkin skill for formatting release notes#1860

Open
gilescope wants to merge 3 commits into
mainfrom
giles-format-release-notes-skill
Open

feat: checkin skill for formatting release notes#1860
gilescope wants to merge 3 commits into
mainfrom
giles-format-release-notes-skill

Conversation

@gilescope

Copy link
Copy Markdown
Contributor

Overview

Skill for updating release notes. It assumes you're in the released branch checkout dir.

Signed-off-by: Giles Cope <gilescope@gmail.com>
@gilescope gilescope requested a review from a team as a code owner July 10, 2026 14:15

@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: f0a022a83b

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .claude/skills/format-release-notes/SKILL.md Outdated
3. For SDK / API pages: signature, parameters, return type, examples, error cases.
4. For config guides: each new flag/env var, default, when to set it, interaction with existing config.
5. For engineering docs: motivation, design alternatives considered, architectural impact, links to relevant code.
6. Cross-link back to the release notes file (`../../release-notes-<VERSION>.md`).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Fix release-note backlink target

For any supporting doc written under docs/release-notes/<VERSION>/, this instructed backlink resolves to docs/release-notes-<VERSION>.md, which is not where the release notes are generated later (release-notes-VERSION.md in the repo root) and also does not match the existing version-folder convention. Generated supporting docs will therefore contain broken links back to the main release notes unless this relative path is corrected.

Useful? React with 👍 / 👎.

Comment thread .claude/skills/format-release-notes/SKILL.md Outdated
Comment thread .claude/skills/format-release-notes/SKILL.md Outdated
Comment thread .claude/skills/format-release-notes/SKILL.md Outdated
demarcate arg

Co-authored-by: Squirrel <giles.cope@shielded.io>
Signed-off-by: Squirrel <giles.cope@shielded.io>

@jina-simulation jina-simulation 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.

Runtime Review - Merge Readiness 5/5

0 issues found - Ready to merge

Jina found no accepted issues.

The investigation outputs contained no candidate issues, and the previously reported inline concerns were addressed in the PR thread.

The remaining observation is non-blocking.

Final review: No publishable issues were identified.

The investigation produced no candidate issues or supporting evidence; existing inline concerns were already addressed in the PR thread.

Review Comments

  • Skill is not CI-enforced

    The skill is currently an optional maintainer aid: no workflow invokes it or validates its output.

    Release operators should not assume that v5 formatting or approval checks are automatically enforced by CI.

    Evidence:

    • Only .claude/skills/format-release-notes/SKILL.md changes in this PR.
    • No repository workflow invokes or validates the skill.

    Related files: .claude/skills/format-release-notes/SKILL.md

Issues

No medium/high-confidence runtime issues were found.

Summary

  • Status: warned
  • Areas investigated: 5
  • Tasks/probes performed: 0
  • Issues reported: 0
  • Publishable issues: 0
  • Inline comments: 0
  • File-level comments: 0
  • Review comments: 1
  • Unanchored publishable findings posted as file-level comments: 0
  • Blocked validations: 0
  • Dashboard: full runtime review
  • Commit: 054bc99
  • Changed files: 1
  • Tool calls: none

Comment thread .claude/skills/format-release-notes/SKILL.md Outdated
Signed-off-by: Squirrel <giles.cope@shielded.io>

@jina-simulation jina-simulation 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.

Runtime Review - Merge Readiness 5/5

0 issues found - Ready to merge

Ready to merge: no accepted issues remain.

All investigation outputs contained empty candidate sets, and existing review concerns were accounted for through PR thread history.

Final review: No publishable issues were identified.

Investigation areas produced no candidate issues, and prior thread concerns were already addressed or are non-blocking.

Issues

No medium/high-confidence runtime issues were found.

Summary

  • Status: warned
  • Areas investigated: 6
  • Tasks/probes performed: 0
  • Issues reported: 0
  • Publishable issues: 0
  • Inline comments: 0
  • File-level comments: 0
  • Review comments: 0
  • Unanchored publishable findings posted as file-level comments: 0
  • Blocked validations: 0
  • Dashboard: full runtime review
  • Commit: cc66006
  • Changed files: 1
  • Tool calls: none

@datadog-official

Copy link
Copy Markdown

Pipelines

⚠️ Warnings

🚦 2 Pipeline jobs failed

+test | Run tests   View in Datadog   GitHub Actions

Changes Check | check-changes   View in Datadog   GitHub Actions

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: cc66006 | Docs | Give us feedback!

@midnightntwrk midnightntwrk deleted a comment from jina-simulation Bot Jul 15, 2026
@midnightntwrk midnightntwrk deleted a comment from jina-simulation Bot Jul 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant