2021-07-12 04:06:13 -04:00
|
|
|
name: OpenAPI
|
|
|
|
on:
|
|
|
|
push:
|
|
|
|
branches:
|
|
|
|
- master
|
2021-11-05 14:09:44 -04:00
|
|
|
pull_request_target:
|
2021-07-12 04:06:13 -04:00
|
|
|
|
2022-12-03 10:47:30 -05:00
|
|
|
permissions: {}
|
|
|
|
|
2021-07-12 04:06:13 -04:00
|
|
|
jobs:
|
|
|
|
openapi-head:
|
|
|
|
name: OpenAPI - HEAD
|
|
|
|
runs-on: ubuntu-latest
|
2021-11-05 17:43:09 -04:00
|
|
|
permissions: read-all
|
2021-07-12 04:06:13 -04:00
|
|
|
steps:
|
|
|
|
- name: Checkout repository
|
2023-04-15 18:57:25 -04:00
|
|
|
uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
|
2021-11-05 14:09:44 -04:00
|
|
|
with:
|
2022-02-19 11:36:53 -05:00
|
|
|
ref: ${{ github.event.pull_request.head.sha }}
|
2021-11-05 17:12:43 -04:00
|
|
|
repository: ${{ github.event.pull_request.head.repo.full_name }}
|
2022-11-09 09:28:52 -05:00
|
|
|
- name: Setup .NET
|
2023-05-29 09:42:21 -04:00
|
|
|
uses: actions/setup-dotnet@3447fd6a9f9e57506b15f895c5b76d3b197dc7c2 # v3.2.0
|
2021-07-12 04:06:13 -04:00
|
|
|
with:
|
2022-11-09 09:28:52 -05:00
|
|
|
dotnet-version: '7.0.x'
|
2021-07-12 04:06:13 -04:00
|
|
|
- name: Generate openapi.json
|
2021-09-15 13:32:55 -04:00
|
|
|
run: dotnet test tests/Jellyfin.Server.Integration.Tests/Jellyfin.Server.Integration.Tests.csproj -c Release --filter "Jellyfin.Server.Integration.Tests.OpenApiSpecTests"
|
2021-07-12 04:06:13 -04:00
|
|
|
- name: Upload openapi.json
|
2023-03-16 00:57:01 -04:00
|
|
|
uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
|
2021-07-12 04:06:13 -04:00
|
|
|
with:
|
|
|
|
name: openapi-head
|
|
|
|
retention-days: 14
|
|
|
|
if-no-files-found: error
|
2022-11-09 09:28:52 -05:00
|
|
|
path: tests/Jellyfin.Server.Integration.Tests/bin/Release/net7.0/openapi.json
|
2021-07-12 04:06:13 -04:00
|
|
|
|
|
|
|
openapi-base:
|
|
|
|
name: OpenAPI - BASE
|
|
|
|
if: ${{ github.base_ref != '' }}
|
|
|
|
runs-on: ubuntu-latest
|
2021-11-05 17:43:09 -04:00
|
|
|
permissions: read-all
|
2021-07-12 04:06:13 -04:00
|
|
|
steps:
|
|
|
|
- name: Checkout repository
|
2023-04-15 18:57:25 -04:00
|
|
|
uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
|
2021-07-12 04:06:13 -04:00
|
|
|
with:
|
2022-12-30 10:08:02 -05:00
|
|
|
ref: ${{ github.event.pull_request.head.sha }}
|
|
|
|
repository: ${{ github.event.pull_request.head.repo.full_name }}
|
|
|
|
fetch-depth: 0
|
|
|
|
- name: Checkout common ancestor
|
|
|
|
run: |
|
|
|
|
git remote add upstream https://github.com/${{ github.event.pull_request.base.repo.full_name }}
|
|
|
|
git -c protocol.version=2 fetch --prune --progress --no-recurse-submodules upstream +refs/heads/*:refs/remotes/upstream/* +refs/tags/*:refs/tags/*
|
|
|
|
ANCESTOR_REF=$(git merge-base upstream/${{ github.base_ref }} origin/${{ github.head_ref }})
|
|
|
|
git checkout --progress --force $ANCESTOR_REF
|
2022-11-09 09:28:52 -05:00
|
|
|
- name: Setup .NET
|
2023-05-29 09:42:21 -04:00
|
|
|
uses: actions/setup-dotnet@3447fd6a9f9e57506b15f895c5b76d3b197dc7c2 # v3.2.0
|
2021-07-12 04:06:13 -04:00
|
|
|
with:
|
2022-11-09 09:28:52 -05:00
|
|
|
dotnet-version: '7.0.x'
|
2021-07-12 04:06:13 -04:00
|
|
|
- name: Generate openapi.json
|
2021-09-15 13:32:55 -04:00
|
|
|
run: dotnet test tests/Jellyfin.Server.Integration.Tests/Jellyfin.Server.Integration.Tests.csproj -c Release --filter "Jellyfin.Server.Integration.Tests.OpenApiSpecTests"
|
2021-07-12 04:06:13 -04:00
|
|
|
- name: Upload openapi.json
|
2023-03-16 00:57:01 -04:00
|
|
|
uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
|
2021-07-12 04:06:13 -04:00
|
|
|
with:
|
|
|
|
name: openapi-base
|
|
|
|
retention-days: 14
|
|
|
|
if-no-files-found: error
|
2022-11-09 09:28:52 -05:00
|
|
|
path: tests/Jellyfin.Server.Integration.Tests/bin/Release/net7.0/openapi.json
|
2021-07-12 04:06:13 -04:00
|
|
|
|
|
|
|
openapi-diff:
|
2022-12-03 10:47:30 -05:00
|
|
|
permissions:
|
|
|
|
pull-requests: write # to create or update comment (peter-evans/create-or-update-comment)
|
|
|
|
|
2021-07-12 04:06:13 -04:00
|
|
|
name: OpenAPI - Difference
|
2021-11-05 14:09:44 -04:00
|
|
|
if: ${{ github.event_name == 'pull_request_target' }}
|
2021-07-12 04:06:13 -04:00
|
|
|
runs-on: ubuntu-latest
|
|
|
|
needs:
|
|
|
|
- openapi-head
|
|
|
|
- openapi-base
|
|
|
|
steps:
|
|
|
|
- name: Download openapi-head
|
2023-03-16 00:57:01 -04:00
|
|
|
uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3.0.2
|
2021-07-12 04:06:13 -04:00
|
|
|
with:
|
|
|
|
name: openapi-head
|
|
|
|
path: openapi-head
|
|
|
|
- name: Download openapi-base
|
2023-03-16 00:57:01 -04:00
|
|
|
uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3.0.2
|
2021-07-12 04:06:13 -04:00
|
|
|
with:
|
|
|
|
name: openapi-base
|
|
|
|
path: openapi-base
|
|
|
|
- name: Workaround openapi-diff issue
|
|
|
|
run: |
|
|
|
|
sed -i 's/"allOf"/"oneOf"/g' openapi-head/openapi.json
|
|
|
|
sed -i 's/"allOf"/"oneOf"/g' openapi-base/openapi.json
|
|
|
|
- name: Calculate OpenAPI difference
|
|
|
|
uses: docker://openapitools/openapi-diff
|
|
|
|
continue-on-error: true
|
|
|
|
with:
|
|
|
|
args: --fail-on-changed --markdown openapi-changes.md openapi-base/openapi.json openapi-head/openapi.json
|
|
|
|
- id: read-diff
|
|
|
|
name: Read openapi-diff output
|
|
|
|
run: |
|
|
|
|
body=$(cat openapi-changes.md)
|
|
|
|
body="${body//'%'/'%25'}"
|
|
|
|
body="${body//$'\n'/'%0A'}"
|
|
|
|
body="${body//$'\r'/'%0D'}"
|
|
|
|
echo ::set-output name=body::$body
|
|
|
|
- name: Find difference comment
|
2023-04-27 09:43:57 -04:00
|
|
|
uses: peter-evans/find-comment@a54c31d7fa095754bfef525c0c8e5e5674c4b4b1 # v2.4.0
|
2021-07-12 04:06:13 -04:00
|
|
|
id: find-comment
|
|
|
|
with:
|
|
|
|
issue-number: ${{ github.event.pull_request.number }}
|
|
|
|
direction: last
|
|
|
|
body-includes: openapi-diff-workflow-comment
|
|
|
|
- name: Reply or edit difference comment (changed)
|
2023-05-01 23:28:33 -04:00
|
|
|
uses: peter-evans/create-or-update-comment@ca08ebd5dc95aa0cd97021e9708fcd6b87138c9b # v3.0.1
|
2021-07-12 04:06:13 -04:00
|
|
|
if: ${{ steps.read-diff.outputs.body != '' }}
|
|
|
|
with:
|
|
|
|
issue-number: ${{ github.event.pull_request.number }}
|
|
|
|
comment-id: ${{ steps.find-comment.outputs.comment-id }}
|
|
|
|
edit-mode: replace
|
|
|
|
body: |
|
|
|
|
<!--openapi-diff-workflow-comment-->
|
|
|
|
<details>
|
|
|
|
<summary>Changes in OpenAPI specification found. Expand to see details.</summary>
|
|
|
|
|
|
|
|
${{ steps.read-diff.outputs.body }}
|
|
|
|
|
|
|
|
</details>
|
|
|
|
- name: Edit difference comment (unchanged)
|
2023-05-01 23:28:33 -04:00
|
|
|
uses: peter-evans/create-or-update-comment@ca08ebd5dc95aa0cd97021e9708fcd6b87138c9b # v3.0.1
|
2021-07-12 04:06:13 -04:00
|
|
|
if: ${{ steps.read-diff.outputs.body == '' && steps.find-comment.outputs.comment-id != '' }}
|
|
|
|
with:
|
|
|
|
issue-number: ${{ github.event.pull_request.number }}
|
|
|
|
comment-id: ${{ steps.find-comment.outputs.comment-id }}
|
|
|
|
edit-mode: replace
|
|
|
|
body: |
|
|
|
|
<!--openapi-diff-workflow-comment-->
|
|
|
|
|
|
|
|
No changes to OpenAPI specification found. See history of this comment for previous changes.
|