Repository navigation
README: one action for the run, .oasdiff.yaml for the rest - #218
Merged
Merged
Conversation
Says what the inputs are for and what belongs in .oasdiff.yaml, describes changelog as the breaking action reporting every change, documents the config input in place of the OASDIFF_CONFIG example, and adds a section on pull requests from forks, including why pull_request_target is the wrong way to get a comment on them. The severity-levels example listed api-version-not-bumped and api-major-version-not-bumped, which oasdiff v1.38.0 retired: a file naming them no longer loads. It now uses two ids that exist. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
…yaml breaking and changelog each carried a table of about twenty inputs, most of them oasdiff flags. breaking now lists the ten inputs that describe a run, changelog refers to that list, and the flag-shaped options are named as configuration that belongs in .oasdiff.yaml. The examples no longer pass github-token, which defaults to the job's token. 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.
Docs only, following #214 to #217.
breakingandchangelogeach carried a table of about twenty inputs, most of them oasdiff flags.breakingnow lists the ten that describe a run (specs,fail-on, tokens,review,config,output-to-file,composed,allow-external-refs), andchangelogrefers to that list.flatten-allof, exclusions, deprecation windows,level,formatand the other oasdiff flags are pointed at.oasdiff.yaml, where the same file gives the same answer locally. The inputs of those names still work and say so in one sentence; nothing is removed from the actions.changelogis described as what it now is: the same action reporting every change.configinput replaces theOASDIFF_CONFIGexample forbreakingandchangelog.github-token, which has defaulted to the job's token all along.pull_request_targetis the wrong way to get a comment on them.severity-levelssample listedapi-version-not-bumpedandapi-major-version-not-bumped, which oasdiff v1.38.0 retired, so a file copied from the README failed to load. It now uses two ids that exist, checked against the v1.38.0 binary.🤖 Generated with Claude Code