BUILD-8677 Add GitHub workflow job summaries and fix deployment documentation#225
Merged
julien-carsique-sonarsource merged 2 commits intomasterfrom Mar 4, 2026
Conversation
julien-carsique-sonarsource
added a commit
to SonarSource/sonar-dummy-gradle-oss
that referenced
this pull request
Mar 3, 2026
Testing SonarSource/ci-github-actions#225 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
julien-carsique-sonarsource
added a commit
to SonarSource/sonar-dummy-js
that referenced
this pull request
Mar 3, 2026
Testing SonarSource/ci-github-actions#225 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
julien-carsique-sonarsource
added a commit
to SonarSource/sonar-dummy-python-oss
that referenced
this pull request
Mar 3, 2026
Testing SonarSource/ci-github-actions#225 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
julien-carsique-sonarsource
added a commit
to SonarSource/sonar-dummy-python-oss
that referenced
this pull request
Mar 3, 2026
Testing SonarSource/ci-github-actions#225 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This was referenced Mar 3, 2026
There was a problem hiding this comment.
Pull request overview
This PR standardizes GitHub Actions job summaries across the build actions and promote, and updates the README to document the new generate-summary input and consolidate deployment strategy documentation.
Changes:
- Add a
generate-summaryinput (default'true') to build actions and gate the summary step behind it; include$GITHUB_JOBin summary headings for easier differentiation. - Fix build summary logic in
build-npm,build-yarn, andbuild-poetryto use the correctsteps.build.outputs.deployedoutput. - Rework README sections: document
generate-summary, introduce a unified “Deployment Strategy” section, and remove redundant “Features” subsections.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
spec/promote_spec.sh |
Extends test env to include GITHUB_JOB required by the updated promote script. |
promote/promote.sh |
Requires GITHUB_JOB and includes it in the promotion job summary heading. |
build-npm/build.sh |
Adds TODO notes about DEPLOY override consistency (no functional change). |
build-npm/action.yml |
Adds generate-summary, includes $GITHUB_JOB in summary heading, fixes deployment check to deployed. |
build-yarn/build.sh |
Adds TODO notes about DEPLOY override consistency (no functional change). |
build-yarn/action.yml |
Adds generate-summary, includes $GITHUB_JOB in summary heading, fixes deployment check to deployed. |
build-poetry/build.sh |
Adds TODO notes about DEPLOY override consistency (no functional change). |
build-poetry/action.yml |
Adds generate-summary, includes $GITHUB_JOB in summary heading, fixes deployment check to deployed. |
build-maven/action.yml |
Includes $GITHUB_JOB in the summary heading (generate-summary already present). |
build-gradle/build.sh |
Adds TODO note documenting known sonar branch-filtering inconsistency. |
build-gradle/action.yml |
Adds generate-summary and includes $GITHUB_JOB in the summary heading. |
README.md |
Documents generate-summary, adds unified “Deployment Strategy”, and restructures sections. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add `$GITHUB_JOB` to the ## heading in all build and promote summaries so jobs sharing the same action are distinguishable - Add missing `generate-summary` input to build-gradle, build-npm, build-poetry, build-yarn (was already present in build-maven). Generalize #222 - Fix bug: build-npm/poetry/yarn summary checked non-existent output `should-deploy`; corrected to `deployed`. Fix #136 - Fix build-yarn: missing blank lines before outputs: and summary step Update README for workflow summary changes - Document `generate-summary` input in build-maven, build-gradle, build-npm, build-poetry, and build-yarn Inputs tables - Add "GitHub workflow job summary" entry to Features sections for build-maven, build-gradle, build-npm, build-yarn, and promote Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Remove all ### Features sections that were either redundant with the action description or contained generic boilerplate. Rescue the branch-strategy information from build-maven as a proper Deployment Strategy table, and rescue the build-gradle gradlew fallback note into the action description. Move Deployment Strategy to standalone section and fix inaccuracies Move the deployment strategy table out of build-maven into a shared standalone section (grouped with Provenance Attestation) since it applies to all build actions. Fix inaccuracies verified against implementation: - feature/long/* branches DO deploy (was incorrectly marked as no) - "master" renamed to "Default branch" (configured via DEFAULT_BRANCH) - Remove Maven-specific "Notes" column that did not apply to other actions - Add build-gradle exception: sonar analysis not branch-filtered in Gradle Note build-gradle sonar branch filtering as a known bug Add a TODO comment in build-gradle/build.sh and update the README to flag that sonar analysis is not filtered by branch type in build-gradle, unlike all other build actions. Should add a should_scan() guard to skip sonar on dogfood/other branches consistently. Fix deploy input verification: document inconsistencies and add TODOs - Fix README Deployment Strategy table: long-lived feature branches only deploy for build-maven and build-gradle, not for build-npm/build-yarn/build-poetry - Add note that deploy:'false' override is only supported by build-maven and build-gradle - Add TODO comments to build-npm, build-yarn, build-poetry noting the missing DEPLOY env var support and long-lived feature branch deploy discrepancy Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
julien-carsique-sonarsource
force-pushed
the
feat/jcarsique/BUILD-8677-actionSummary
branch
from
8ddc699 to
c176b03
Compare
SonarQube reviewer guideSummary: Documentation restructuring and feature consistency updates across build actions. The PR removes feature lists from individual action sections, consolidates deployment strategy documentation, relocates AI migration guidance, adds Review Focus: Pay attention to:
Start review at:
|
julien-carsique-sonarsource
deleted the
feat/jcarsique/BUILD-8677-actionSummary
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
generate-summaryinput to all build actions (build-maven,build-gradle,build-npm,build-yarn,build-poetry) with default'true', enabling a standardized Markdown job summary written to$GITHUB_STEP_SUMMARYafter each build$GITHUB_JOBin the summary heading so jobs sharing the same action are distinguishable in the GitHub UIbuild-npm,build-yarn, andbuild-poetrysummaries checked a non-existent outputshould-deploy; corrected todeployed$GITHUB_JOBto thepromoteaction summary as well for consistencyDocumentation (README)
generate-summaryinput in all five build actions' Inputs tables### Featuressubsections (redundant, inconsistent, low value) and rescue useful content inlinebuild-gradledoes not filter SonarQube analysis by branch type (runs on dogfood/other branches unlike all other actions)build-npm,build-yarn,build-poetrylack thedeploy: 'false'override input available inbuild-maven/build-gradlefeature/long/*) deployment is enabled inbuild-maven/build-gradlebut disabled inbuild-npm/build-yarn/build-poetryFollow-up
Inconsistencies documented with TODO BUILD-10586 comments.
Test plan
generate-summarystep renders correctly in GitHub Actions job summary UI (build succeeded / failed, project, version, build number, branch, commit, deployment link)Verify the summary step is skipped whengenerate-summary: 'false'is setVerify the summary step still runs when the build step fails (if: always())deployedoutput drives the deployment section in the summaryTests