From 90f693960c2ba99eddb5dfa4c43a5ce28eb95f8a Mon Sep 17 00:00:00 2001 From: Reuven Harrison Date: Sun, 15 Nov 2026 18:14:26 +0200 Subject: [PATCH] Demo: changelog@pr-comment-lists-changes with an oasdiff token Four endpoint and schema edits that break clients, plus three added optional properties and a version bump, so the comment has a mixed severity set to order. Co-Authored-By: Claude Opus 5 --- .github/workflows/free-review.yml | 19 --------------- .../workflows/{pro-review.yml => oasdiff.yml} | 8 +++---- .github/workflows/pr-comment.yml | 23 ------------------- simple.yaml | 19 +++++++-------- 4 files changed, 14 insertions(+), 55 deletions(-) delete mode 100644 .github/workflows/free-review.yml rename .github/workflows/{pro-review.yml => oasdiff.yml} (76%) delete mode 100644 .github/workflows/pr-comment.yml diff --git a/.github/workflows/free-review.yml b/.github/workflows/free-review.yml deleted file mode 100644 index 7400ddb..0000000 --- a/.github/workflows/free-review.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: oasdiff -on: - pull_request: - branches: [ "main" ] -permissions: - contents: read - pull-requests: write -jobs: - breaking-changes: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v6 - - run: git fetch --depth=1 origin ${{ github.base_ref }} - - uses: oasdiff/oasdiff-action/breaking@v0 - with: - base: 'origin/${{ github.base_ref }}:simple.yaml' - revision: 'HEAD:simple.yaml' - fail-on: WARN - github-token: ${{ github.token }} diff --git a/.github/workflows/pro-review.yml b/.github/workflows/oasdiff.yml similarity index 76% rename from .github/workflows/pro-review.yml rename to .github/workflows/oasdiff.yml index 4b64cca..c73d903 100644 --- a/.github/workflows/pro-review.yml +++ b/.github/workflows/oasdiff.yml @@ -1,4 +1,4 @@ -name: oasdiff pro review +name: oasdiff on: pull_request: branches: [ "main" ] @@ -7,12 +7,12 @@ permissions: pull-requests: write statuses: write jobs: - pro-review: + oasdiff: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - run: git fetch --depth=1 origin ${{ github.base_ref }} - - uses: oasdiff/oasdiff-action/changelog@v0 + - uses: oasdiff/oasdiff-action/changelog@pr-comment-lists-changes with: base: 'origin/${{ github.base_ref }}:simple.yaml' revision: 'HEAD:simple.yaml' diff --git a/.github/workflows/pr-comment.yml b/.github/workflows/pr-comment.yml deleted file mode 100644 index 63be70f..0000000 --- a/.github/workflows/pr-comment.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: oasdiff PR comment - -on: - pull_request: - -permissions: - contents: read - pull-requests: write - statuses: write - -jobs: - pr-comment: - runs-on: ubuntu-latest - steps: - - name: Check out code - uses: actions/checkout@v4 - - - name: Post oasdiff PR comment - uses: oasdiff/oasdiff-action/pr-comment@v0 - with: - base: https://raw.githubusercontent.com/${{ github.repository }}/${{ github.base_ref }}/simple.yaml - revision: simple.yaml - oasdiff-token: ${{ secrets.OASDIFF_TOKEN }} diff --git a/simple.yaml b/simple.yaml index b635d93..0a8f8ea 100644 --- a/simple.yaml +++ b/simple.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Tufin - version: "3.0" + version: "3.1" servers: - url: https://localhost:8080 components: @@ -9,7 +9,7 @@ components: groupId: in: query name: groupId - required: false + required: true schema: type: string schemas: @@ -19,6 +19,12 @@ components: data: type: object properties: + label: + type: string + owner: + type: string + tier: + type: string created: type: string format: date-time @@ -28,9 +34,10 @@ components: type: string readOnly: true name: - type: string + type: integer required: - name + - id paths: /api/v1.0/groups: post: @@ -45,12 +52,6 @@ paths: description: Creates one project. required: true responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/GroupView' - description: SUCCESS "400": content: application/json: