Skip to content

[8.18] Output validation comments even without changes (#4781) #4802

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
merged 1 commit into from
Jul 7, 2025
Merged

[8.18] Output validation comments even without changes (#4781) #4802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 5 additions & 7 deletions .github/validate-pr/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,20 +144,18 @@ async function run() {
}
changedApis.sort((a, b) => a.api.localeCompare(b.api))

let comment = `Following you can find the validation changes against the target branch for the API${changedApis.length === 1 ? '' : 's'}.\n\n`
if (changedApis.length > 0) {
let comment = `Following you can find the validation changes for the API${changedApis.length === 1 ? '' : 's'} you have modified.\n\n`
comment += '| API | Status | Request | Response |\n'
comment += '| --- | --- | --- | --- |\n'
for (const change of changedApis) {
comment += buildDiffTableLine(change)
}
comment += `\nYou can validate ${changedApis.length === 1 ? 'this' : 'these'} API${changedApis.length === 1 ? '' : 's'} yourself by using the ${tick}make validate${tick} target.\n`

core.setOutput('has_results', 'true')
core.setOutput('comment_body', comment)
} else {
core.setOutput('has_results', 'false')
comment += '**No changes detected**.\n'
}
comment += `\nYou can validate ${changedApis.length === 1 ? 'this' : 'these'} API${changedApis.length === 1 ? '' : 's'} yourself by using the ${tick}make validate${tick} target.\n`
core.setOutput('comment_body', comment)

core.info('Done!')
}
Expand Down Expand Up @@ -231,4 +229,4 @@ function generateResponse (r) {
run().catch((err) => {
core.error(err)
process.exit(1)
})
})
1 change: 0 additions & 1 deletion .github/workflows/validate-pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ jobs:
body-includes: 'Following you can find the validation changes'

- name: Create or update comment
if: steps.validation.outputs.has_results == 'true'
uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
with:
token: ${{ secrets.GITHUB_TOKEN }}
Expand Down