1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-09-24 17:51:14 +02:00

chore: improve openapi diff output

This commit is contained in:
Gastón Fournier 2025-08-28 18:55:36 +02:00
parent 8364498c22
commit 0a6850889a
No known key found for this signature in database
GPG Key ID: AF45428626E17A8E

View File

@ -121,7 +121,7 @@ jobs:
id: diff id: diff
run: | run: |
docker run --rm -t -v $(pwd):/specs:ro tufin/oasdiff changelog --format markdown /specs/openapi-stable.json /specs/openapi-current.json > openapi-diff.txt || true docker run --rm -t -v $(pwd):/specs:ro tufin/oasdiff changelog --format markdown /specs/openapi-stable.json /specs/openapi-current.json > openapi-diff.txt || true
# then output in a format that can be used in GitHub Actions # then output in a format that is useful when you go inside the job output
docker run --rm -t -v $(pwd):/specs:ro tufin/oasdiff changelog --format githubactions /specs/openapi-stable.json /specs/openapi-current.json docker run --rm -t -v $(pwd):/specs:ro tufin/oasdiff changelog --format githubactions /specs/openapi-stable.json /specs/openapi-current.json
- name: Comment on PR with OpenAPI diff - name: Comment on PR with OpenAPI diff
uses: actions/github-script@v7 uses: actions/github-script@v7
@ -130,7 +130,7 @@ jobs:
const fs = require('fs'); const fs = require('fs');
const diff = fs.readFileSync('openapi-diff.txt', 'utf8'); const diff = fs.readFileSync('openapi-diff.txt', 'utf8');
const diffLines = diff.split('\n').filter(line => line.trim() !== '' && !line.startsWith('#')).length; const diffLines = diff.split('\n').filter(line => line.trim() !== '' && !line.startsWith('#')).length;
const marker = '### OpenAPI Diff'; const marker = '[//]: # (OpenAPI diff - used to identify the comment)';
// Get all comments on the PR // Get all comments on the PR
const { data: comments } = await github.rest.issues.listComments({ const { data: comments } = await github.rest.issues.listComments({
issue_number: context.issue.number, issue_number: context.issue.number,
@ -144,7 +144,7 @@ jobs:
body = `${marker} too long, check the this task output for details.`; body = `${marker} too long, check the this task output for details.`;
console.log(diff); console.log(diff);
} else if (diffLines > 0) { } else if (diffLines > 0) {
body = `${marker}\n\n\`\`\`diff\n${diff}\n\`\`\``; body = `${marker}\n${diff}`;
} else { } else {
body = null; body = null;
} }