Skip to content

Run the verify-api action on this repository's own api/ - #105

Merged
Mpdreamz merged 2 commits into
mainfrom
verify-api-dogfood
Nov 14, 2026
Merged

Mpdreamz merged 2 commits into
mainfrom
verify-api-dogfood

Conversation

@Mpdreamz

@Mpdreamz Mpdreamz commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

A new workflow, verify-api.yml, runs the verify-api action on this repository's own api/ on every pull request. It uses the action from the checkout (uses: ./verify-api) with the released tool, so the action is tested end to end, and with comment: true, so the comment is tested too.

Tested on this pull request, in two pushes

  1. Stale. api/ was deliberately stale: one property removed from Nullean.PublicApi.Diff.api. The verify-api job failed, and so did the build job's verifyapi step. The action posted this comment:

    Public API files are out of date

    Suggested version change: Minor

    [api] Nullean.PublicApi.Diff: 1 change since the committed files, suggested version change: Minor
      api/Nullean.PublicApi.Diff.api:52  Nullean.PublicApi.Diff › ApiComparisonResult › Breaking  added IEnumerable<ApiChange> Breaking { get; }  [minor]
    

    Update them with assembly-differ api --project … -o api, and commit the result.

  2. Restored. With the file back, both jobs passed. The same comment was updated in place to "Public API files match the build"; it's still the pull request's only comment.

A fix to the action

On a pull request from a fork, the token can't write. The comment calls now warn ("the token needs pull-requests: write") instead of failing the step, and failing is left to the check, which still exits 5 when the files are stale.

🤖 Generated with Claude Code

…n purpose for the first run)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Mpdreamz Mpdreamz added the ci Build and automation (patch) label Nov 14, 2026
@github-actions

github-actions Bot commented Nov 14, 2026 •

Copy link
Copy Markdown

Public API files match the build

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Mpdreamz
Mpdreamz merged commit 574eea1 into main Nov 14, 2026
7 checks passed
@Mpdreamz
Mpdreamz deleted the verify-api-dogfood branch November 14, 2026 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Build and automation (patch)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant