Skip to content

GHA-190 Refactor rule metadata summary generation and update PR creation step#98

Merged
nils-werner-sonarsource merged 2 commits intomasterfrom
nw/update-rule-metadata-action
Feb 23, 2026
Merged

GHA-190 Refactor rule metadata summary generation and update PR creation step#98
nils-werner-sonarsource merged 2 commits intomasterfrom
nw/update-rule-metadata-action

Conversation

@nils-werner-sonarsource
Copy link
Contributor

@nils-werner-sonarsource nils-werner-sonarsource commented Feb 22, 2026

This pull request refactors the summary generation and pull request creation steps in the update-rule-metadata/action.yml workflow. The changes improve the formatting and clarity of the rule metadata update summary, and switch to a custom action for creating pull requests.

Summary generation improvements:

  • The summary is now written to a markdown file (rule-api-summary.md) as a table, providing clearer and more structured information about rules to update per Sonarpedia, including a total count.
  • The summary output preserves newlines using GitHub Actions' multiline output syntax, ensuring proper formatting in the PR body.
  • The previous step that replaced newlines with <br> tags for PR summary formatting has been removed, as the new approach handles formatting natively.

Pull request creation changes:

  • The workflow now uses the custom SonarSource/release-github-actions/create-pull-request@v1 action instead of the generic peter-evans/create-pull-request, allowing for more tailored PR creation.
  • The PR body now directly includes the improved summary output from the summary generation step.

Test

  • Use action in analyzer project
  • Ensure PR is created and pipeline is triggered

@hashicorp-vault-sonar-prod hashicorp-vault-sonar-prod bot changed the title Refactor rule metadata summary generation and update PR creation step GHA-190 Refactor rule metadata summary generation and update PR creation step Feb 22, 2026
@hashicorp-vault-sonar-prod
Copy link

hashicorp-vault-sonar-prod bot commented Feb 22, 2026

GHA-190

@sonarqubecloud
Copy link

@nils-werner-sonarsource nils-werner-sonarsource merged commit dc3be18 into master Feb 23, 2026
10 checks passed
@nils-werner-sonarsource nils-werner-sonarsource deleted the nw/update-rule-metadata-action branch February 23, 2026 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants