Skip to content

Refine AGENTS.md changelog guidance: silence Codex noise and reserve .changed for breaking changes#24275

Open
Kyle-Neale wants to merge 2 commits into
masterfrom
kyle.neale/codex-skip-changelog-finding
Open

Refine AGENTS.md changelog guidance: silence Codex noise and reserve .changed for breaking changes#24275
Kyle-Neale wants to merge 2 commits into
masterfrom
kyle.neale/codex-skip-changelog-finding

Conversation

@Kyle-Neale

@Kyle-Neale Kyle-Neale commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Two related refinements to the changelog guidance in the top-level AGENTS.md:

  1. Adds a Review Guidelines section instructing the Codex code-review bot (chatgpt-codex-connector[bot]) not to raise a finding for a missing changelog entry.
  2. Tightens the changed entry-type definition to backward-incompatible changes only, and adds a Choosing .changed guardrail that tells agents to pause and confirm a change is genuinely breaking before using .changed.

The changelog requirement for authored code is unchanged.

Motivation

Both changes address feedback from Eric Weaver in #agent-integrations Slack. AGENTS.md is the single source both Codex and Claude read for changelog behavior, so tightening the guidance here reshapes both agents at once.

Codex missing-changelog noise. Codex derives its review rules from AGENTS.md, so the existing "changelog entries are required" rule makes it post a finding asking for a changelog on essentially every non-draft PR (e.g. this P2 on #24243). That finding is both unavoidable and redundant:

  • Changelog files are named <INTEGRATION>/changelog.d/<PR_NUMBER>.<TYPE>, so they can only be created after the PR number is assigned. Our own AGENTS.md tells contributors to open the PR first and add the entry afterward, so the entry is legitimately absent when the PR is first reviewed.
  • The requirement is already enforced by the check_changelog job in .github/workflows/pr-quick-check.yml.

Over-use of .changed. The changed type was defined as "Breaking changes or significant modifications", and that loose "or significant modifications" phrasing led agents to tag non-breaking work as .changed (which bumps the major version). The definition is now backward-incompatible-only, with an explicit guardrail to stop and reconsider before choosing it.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Add qa/required if this PR needs QA validation, or qa/skip-qa if it does not. Exactly one of the two is required.
  • If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

🤖 Generated with Claude Code

The Codex code-review bot derives its rules from AGENTS.md and was
raising a finding asking for a changelog entry on essentially every
non-draft PR. Changelog files are named
`<INTEGRATION>/changelog.d/<PR_NUMBER>.<TYPE>`, so they can only be
created after the PR number is assigned -- their absence at review time
is expected, not a defect, and the requirement is already enforced by
the check_changelog job in pr-quick-check.yml.

Add a Review Guidelines section instructing the reviewer to skip this
finding, without relaxing the changelog requirement for authored code.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Kyle-Neale Kyle-Neale added the qa/skip-qa Automatically skip this PR for the next QA label Jun 30, 2026
@Kyle-Neale Kyle-Neale marked this pull request as ready for review July 1, 2026 20:18
@Kyle-Neale Kyle-Neale requested a review from a team as a code owner July 1, 2026 20:18
Tighten the changelog guidance in AGENTS.md so agents stop tagging
non-breaking work as `.changed`. Rewords the `changed` definition to
backward-incompatible changes only, and adds a "Choosing .changed"
guardrail that instructs pausing to confirm the change is genuinely
breaking before using it.

Raised by Eric Weaver in #agent-integrations Slack.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@dd-octo-sts

dd-octo-sts Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Validation Report

All 21 validations passed.

Show details
Validation Description Status
agent-reqs Verify check versions match the Agent requirements file
ci Validate CI configuration and code coverage settings
codeowners Validate every integration has a CODEOWNERS entry
config Validate default configuration files against spec.yaml
dep Verify dependency pins are consistent and Agent-compatible
http Validate integrations use the HTTP wrapper correctly
imports Validate check imports do not use deprecated modules
integration-style Validate check code style conventions
jmx-metrics Validate JMX metrics definition files and config
labeler Validate PR labeler config matches integration directories
legacy-signature Validate no integration uses the legacy Agent check signature
license-headers Validate Python files have proper license headers
licenses Validate third-party license attribution list
metadata Validate metadata.csv metric definitions
models Validate configuration data models match spec.yaml
openmetrics Validate OpenMetrics integrations disable the metric limit
package Validate Python package metadata and naming
qa-label Validate the pull request declares whether it needs QA for the next Agent release
readmes Validate README files have required sections
saved-views Validate saved view JSON file structure and fields
version Validate version consistency between package and changelog

View full run

@Kyle-Neale Kyle-Neale changed the title Stop Codex review bot from flagging missing changelog entries Refine AGENTS.md changelog guidance: silence Codex noise and reserve .changed for breaking changes Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

qa/skip-qa Automatically skip this PR for the next QA team/agent-integrations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant