Skip to content

Add GitHub Action to detect breaking changes #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
reuvenharrison wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Add GitHub Action to detect breaking changes #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c47ead2
Add GitHub Action to detect breaking changes
reuvenharrison Apr 18, 2026
3f4ec32
Update paths in breaking-changes.yaml
reuvenharrison Apr 18, 2026
95dc00c
Update paths for base and revision in workflow
reuvenharrison Apr 18, 2026
29b0b77
Update breaking changes workflow to use dynamic refs
reuvenharrison Apr 18, 2026
4cf42ed
Add checkout action and fetch command to workflow
reuvenharrison Apr 18, 2026
e97f51e
Make groupId parameter required in simple.yaml
reuvenharrison Apr 18, 2026
832b1fd
Update schema to include 'id' as a required field
reuvenharrison Apr 18, 2026
d2de5d3
break
reuvenharrison Apr 18, 2026
4c07d52
Add fail-on option to breaking changes workflow
reuvenharrison Apr 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/breaking-changes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: detect-breaking-changes
on:
pull_request:
branches: [ "main" ]
jobs:
oasdiff:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6

- run: git fetch --depth=1 origin ${{ github.base_ref }}

- uses: oasdiff/oasdiff-action/breaking@v0.0.40-beta.2
with:
base: 'origin/${{ github.base_ref }}:simple.yaml'
revision: 'HEAD:simple.yaml'
fail-on: WARN
3 changes: 3 additions & 0 deletions simple.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,11 @@
readOnly: true
name:
type: string
email:

Check failure on line 32 in simple.yaml

View workflow job for this annotation

GitHub Actions / oasdiff

new-required-request-property 

in API POST /api/v1.0/groups added the new required request property `data/email`
type: string
required:
- name
- email
paths:
/api/v1.0/groups:
post:
Expand Down
Loading