Skip to content

Add the Pro token to breaking, fail-on to changelog, and a config input - #216

Merged
reuvenharrison merged 2 commits into
mainfrom
run-level-inputs
Nov 15, 2026
Merged

reuvenharrison merged 2 commits into
mainfrom
run-level-inputs

Conversation

@reuvenharrison

@reuvenharrison reuvenharrison commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Follows #215. Three run-level inputs, each on the action that lacked it.

oasdiff-token on breaking

Pro existed only on changelog, so a workflow built on breaking had to switch actions to upgrade. With the token, breaking now uploads an authenticated review of the breaking changes, posts the review comment and sets the oasdiff commit status:

      - uses: oasdiff/oasdiff-action/breaking@v0
        with:
          base: 'origin/${{ github.base_ref }}:openapi.yaml'
          revision: 'HEAD:openapi.yaml'
          oasdiff-token: ${{ secrets.OASDIFF_TOKEN }}

Verified against production in a real pull request: the comment listed the three breaking changes with the gate line, and the head commit got oasdiff: pending — API changes need review, linking to the review.

fail-on on changelog

A changelog could not fail a job. The script captured oasdiff's exit code and never returned it, which also meant a fail-on in .oasdiff.yaml was ignored on this action while level from the same file was honored. It now exits with that code.

This is the one behavior change: a changelog workflow whose .oasdiff.yaml already sets fail-on starts failing where it used to pass. That is what the file says, but it is worth a line in the release notes.

config on both

The path to an oasdiff config file, for a repository that does not keep .oasdiff.yaml at its root.

Also

The README said github-token defaults to an empty string. Both action.yml files have defaulted it to the job's own token all along, so the table now says so, and the Pro example no longer passes it.

Checks

  • The old-against-new differential from Run breaking and changelog from one entrypoint #215, rerun on this branch for the inputs that already existed: 294 runs compared, 0 differing.
  • New jobs: the Pro path on breaking (asserts the upload ran oasdiff breaking, the comment body and the pending status), fail-on on changelog from the input and from .oasdiff.yaml, and the config input.

🤖 Generated with Claude Code

reuvenharrison and others added 2 commits November 15, 2026 19:58
With an oasdiff-token, the breaking action is now the Pro action: it
uploads an authenticated review of the breaking changes, posts the review
comment and sets the oasdiff commit status. Pro used to exist only on
changelog, so a workflow built on breaking had to switch actions to
upgrade.

changelog takes fail-on. Its script captured oasdiff's exit code and never
returned it, so a changelog could not fail a job, and a fail-on in
.oasdiff.yaml was ignored there while level from the same file was
honored. It now exits with that code.

Both actions take config, the path to an oasdiff config file, for a
repository that does not keep .oasdiff.yaml at its root.

The README said github-token defaults to an empty string; action.yml has
defaulted it to the job's token all along.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
specs/revision.yaml differs from the base by one info-level change, so
fail-on: ERR rightly did not fail the job.

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