Skip to content

Annotate errors and warnings from the changelog action - #217

Merged
reuvenharrison merged 1 commit into
mainfrom
changelog-annotations
Nov 15, 2026
Merged

reuvenharrison merged 1 commit into
mainfrom
changelog-annotations

Conversation

@reuvenharrison

@reuvenharrison reuvenharrison commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Follows #216.

Only breaking wrote inline annotations. A changelog workflow, which is what the Pro example used until #216, put nothing on the Files changed tab, so the PR comment was the only place its changes appeared.

changelog now writes the same annotations for the changes at error and warning level:

::error title=request-property-type-changed,file=openapi.yaml,line=37,col=15::in API POST /api/v1.0/groups the `data/name` request property `type` changed from `string` to `integer`

Info changes are left out. A changelog can hold one per added property (the demo spec has 8 info changes next to its 3 errors), and a notice for each would bury the ones that matter.

This is a visible change for existing changelog workflows: pull requests with error or warning changes get annotations they did not get before. The action's outputs, exit code and report are unchanged. The annotation format writes error_count, warning_count and info_count to GITHUB_OUTPUT; this action does not declare those and its info_count would be wrong with info filtered out, so they are kept out, and a test asserts it.

It costs one more oasdiff run per job on this action, the same one breaking already makes.

🤖 Generated with Claude Code

Only breaking wrote inline annotations, so a changelog workflow, which is
what the Pro example used, put nothing on the Files changed tab. changelog
now writes them for the changes at error and warning level. Info changes
are left out: a changelog can hold one per added property.

The annotation format also writes error_count, warning_count and
info_count to GITHUB_OUTPUT. This action does not declare those outputs
and its info_count would be wrong with info filtered out, so that file is
pointed away for this one render.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Base automatically changed from run-level-inputs to main November 15, 2026 18:36
@reuvenharrison
reuvenharrison merged commit 8e029ef into main Nov 15, 2026
46 checks passed
@reuvenharrison
reuvenharrison deleted the changelog-annotations branch November 15, 2026 18:38
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.

1 participant