Repository navigation
Add the Pro token to breaking, fail-on to changelog, and a config input - #216
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follows #215. Three run-level inputs, each on the action that lacked it.
oasdiff-tokenonbreakingPro existed only on
changelog, so a workflow built onbreakinghad to switch actions to upgrade. With the token,breakingnow uploads an authenticated review of the breaking changes, posts the review comment and sets theoasdiffcommit status: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-ononchangelogA changelog could not fail a job. The script captured oasdiff's exit code and never returned it, which also meant a
fail-onin.oasdiff.yamlwas ignored on this action whilelevelfrom the same file was honored. It now exits with that code.This is the one behavior change: a
changelogworkflow whose.oasdiff.yamlalready setsfail-onstarts failing where it used to pass. That is what the file says, but it is worth a line in the release notes.configon bothThe path to an oasdiff config file, for a repository that does not keep
.oasdiff.yamlat its root.Also
The README said
github-tokendefaults to an empty string. Bothaction.ymlfiles 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
breaking(asserts the upload ranoasdiff breaking, the comment body and the pending status),fail-ononchangelogfrom the input and from.oasdiff.yaml, and theconfiginput.🤖 Generated with Claude Code