Skip to content

openapi-diff action #3

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

Merged
Pentusha merged 2 commits into from
Oct 6, 2025
Merged

openapi-diff action #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f860301
openapi-diff action
Pentusha Oct 6, 2025
0ec181b
Update .github/workflows/changelog.yaml
Pentusha Oct 6, 2025
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
45 changes: 42 additions & 3 deletions .github/workflows/changelog.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ on:
type: string
AWS_CODEARTIFACT_DOMAIN:
type: string
diff-tool:
type: string
default: oasdiff

jobs:
changelog:
Expand Down Expand Up @@ -134,26 +137,62 @@ jobs:
- name: Running OpenAPI Spec diff action
id: spec_diff
uses: oasdiff/oasdiff-action/changelog@main
if: ${{ inputs.diff-tool == 'oasdiff' }}
with:
base: base/artefacts/spec.yaml
revision: current/artefacts/spec.yaml

- name: Running OpenAPI Diff action
id: spec_diff
uses: Pentusha/openapi-diff-action@v0.0.1
if: ${{ inputs.diff-tool == 'openapi-diff' }}
with:
old-spec: base/artefacts/spec.yaml
new-spec: current/artefacts/spec.yaml
markdown: openapi-diff.md

- name: Update pull request
uses: nefrob/pr-description@v1.1.2
if: ${{ inputs.diff-tool == 'oasdiff' }}
with:
content: "<!-- spec_changelog -->\n${{join(steps.spec_diff.outputs.*, '\n')}}\n<!-- spec_changelog -->"
token: ${{ secrets.GITHUB_TOKEN }}
regex: "<!-- spec_changelog -->.*?<!-- spec_changelog -->"
regexFlags: ims

- name: Read openapi-diff.md file
if: ${{ inputs.diff-tool == 'openapi-diff' }}
id: read_diff
run: |
echo 'diff_content<<EOF' >> $GITHUB_OUTPUT
cat openapi-diff.md >> $GITHUB_OUTPUT
echo 'EOF' >> $GITHUB_OUTPUT

- name: Update pull request
uses: nefrob/pr-description@v1.1.2
if: ${{ inputs.diff-tool == 'openapi-diff' }}
with:
content: "<!-- spec_changelog -->\n${{ steps.read_diff.outputs.diff_content }}\n<!-- spec_changelog -->"
token: ${{ secrets.GITHUB_TOKEN }}
regex: "<!-- spec_changelog -->.*?<!-- spec_changelog -->"
regexFlags: ims

- name: Add label to PR
if: inputs.diff-tool == 'oasdiff' && contains(steps.spec_diff.outputs.changelog, 'error [')
run: |
gh pr edit ${{ github.event.pull_request.number }} --add-label breaking-changes
working-directory: current
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Add label to PR
if: contains(steps.spec_diff.outputs.changelog, 'error [')
if: inputs.diff-tool == 'openapi-diff' && !steps.spec_diff.outputs.state.compatible
run: |
gh pr edit ${{ github.event.pull_request.number }} --add-label breaking-changes
working-directory: current
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Labeler
uses: actions/labeler@v5
with:
Expand Down