v0.0.48

Highlights

New: validate action

Validate a single OpenAPI spec in CI against the OpenAPI and JSON Schema rules, with a GitHub annotation on the exact line and column of every finding. Findings are graded by severity (error, warning, info), and by default the step fails only on errors.

- uses: oasdiff/oasdiff-action/validate@v0.0.48
  with:
    spec: 'openapi.yaml'

Inputs: spec (required), fail-on (ERR / WARN / INFO), allow-external-refs. Outputs: findings, error_count, warning_count, info_count. For a report-only run, leave fail-on empty and set continue-on-error: true on the step. See the README for full details.

Upgraded to oasdiff v1.16.0

Every action now runs on oasdiff v1.16.0, which adds validate, upgrade, --auto-upgrade, and case-insensitive severity/level flags.

Fixes

• Large changelogs no longer break the PR comment. The pr-comment action now pipes both the changes payload and the POST body via stdin, so specs whose changelog exceeds the command-line size limit (ARG_MAX) post correctly (#118, #119).
• Stable review links. Free /review links now pin to the immutable base commit SHA instead of a branch name, so a shared link keeps working after the branch advances (#117).
• URL-style spec inputs keep their scheme. A base or revision given as a full https:// URL is passed through unchanged by the breaking, changelog, and pr-comment actions instead of having https: stripped (#120, #121).
• Docs and CI housekeeping (#122, #123).

Full Changelog: v0.0.47...v0.0.48

v0.0.47

Highlights

New: configure the actions with .oasdiff.yaml

All four actions (breaking, changelog, diff, pr-comment) now automatically pick up a .oasdiff.yaml file from the root of your checked-out repository, so you can keep CLI-flag-shaped options in source control instead of repeating the same with: block in every workflow.

# .oasdiff.yaml
fail-on: ERR
exclude-elements:
  - description
  - title
  - summary

• Precedence: action with: inputs override .oasdiff.yaml, which overrides the built-in defaults.
• Custom path: set OASDIFF_CONFIG in the workflow env: to point at a config file elsewhere.
• The older oasdiff.yaml (no leading dot) still works as a fallback.

See the "Configuring with .oasdiff.yaml" section of the README and the oasdiff config-file reference for the full list of keys.

Upgraded to oasdiff v1.15.3

Fixes

• fail-on from .oasdiff.yaml is honored correctly. The breaking action now runs oasdiff fewer times and tolerates oasdiff's non-zero exit when a config-file fail-on fires, so the threshold is applied without the step erroring out for the wrong reason (#112).

Full Changelog: v0.0.46...v0.0.47

v0.0.46

What's Changed

• bump: oasdiff v1.15.2 by @reuvenharrison in #108

Full Changelog: v0.0.45...v0.0.46

v0.0.45

What's Changed

• chore: bump README references to v0.0.44 by @reuvenharrison in #106
• bump: oasdiff v1.15.1 by @reuvenharrison in #107

Full Changelog: v0.0.44...v0.0.45

v0.0.44

What's Changed

• chore: bump README references to v0.0.43 by @reuvenharrison in #104
• feat(pr-comment): handle 409 github_app_not_installed gracefully by @reuvenharrison in #105

Full Changelog: v0.0.43...v0.0.44

v0.0.43

What's Changed

• chore: bump README references to v0.0.42 by @reuvenharrison in #102
• feat(changelog): emit free review link when changes are found by @reuvenharrison in #103

Full Changelog: v0.0.42...v0.0.43

v0.0.42

What's Changed

• feat(pr-comment): capture pull_request.base.sha as base_sha by @reuvenharrison in #101

Full Changelog: v0.0.41...v0.0.42

v0.0.41

OpenAPI 3.1 support is generally available

v0.0.41 updates the bundled oasdiff to v1.15.0, making OpenAPI 3.1 support generally available across all action variants (breaking, changelog, diff, pr-comment).

What this means for your workflows

Pin to oasdiff/oasdiff-action/<command>@v0.0.41. With this release:

• 3.1 specs (openapi: 3.1.0) are parsed, diffed, and checked for breaking changes end-to-end.
• 162 new rule IDs cover 3.1-specific keywords: webhooks, type arrays with null, const, prefixItems, if/then/else, numeric exclusiveMinimum/exclusiveMaximum, dependentRequired, unevaluatedItems/Properties, contentSchema, and more.
• All operation-level breaking-change checks now apply to modified webhook operations.

See also

• oasdiff v1.15.0 release notes for the full 3.1 GA details.
• oasdiff OpenAPI 3.1 doc for supported features and known caveats.

Bumps since v0.0.40-beta.3

• Bundled oasdiff: v1.15.0-openapi31.beta.3 to v1.15.0
• README examples updated to reference v0.0.41 and v1.15.0

v0.0.40-beta.3 — OpenAPI 3.1 Support

Changes since v0.0.40-beta.1

• Bump oasdiff Docker image to v1.15.0-openapi31.beta.3
• Improve README examples for easier onboarding
• Point Pro section to Installation Wizard

v0.0.40-beta.1 — OpenAPI 3.1 Support

OpenAPI 3.1 Support (Beta)

This release uses tufin/oasdiff:v1.15.0-openapi31.beta.1, adding full OpenAPI 3.1 support to all actions: diff, breaking, changelog, and pr-comment.

What's new

• 464 breaking change rules (up from 316) — 148 new rules for 3.1-specific keywords
• Webhooks, nullable type arrays, JSON Schema 2020-12 keywords (const, prefixItems, if/then/else, contains, dependentRequired, and more)
• Fully backward compatible — 3.0.x specs work exactly as before

Usage

- uses: oasdiff/oasdiff-action/breaking@v0.0.40-beta.1
  with:
    base: 'specs/base.yaml'
    revision: 'specs/revision.yaml'

Feedback

Please report issues with [3.1] in the title at oasdiff/oasdiff.