GHA-123 Add how-to for analyzer release automation #52
Conversation
…, and some context. To be reviewed and improved manually.
hashicorp-vault-sonar-prod
bot
changed the title
anton-haubner-sonarsource
force-pushed
the
ahbnr/document-analyzer-release-automation
branch
from
65390db to
afde7d4
Compare
anton-haubner-sonarsource
force-pushed
the
ahbnr/document-analyzer-release-automation
branch
7 times, most recently
from
b2f8766 to
8844354
Compare
| # release-github-actions | ||
|
|
||
| A centralized collection of reusable GitHub Actions designed to streamline and automate every stage of the analyzer release process. This repository serves as a versatile toolbox, offering modular automations to eliminate manual, repetitive steps and reduce friction across squads managing analyzer projects. Whether standardizing changelog generation, automating version bumps, handling release publishing, or coordinating cross-repository tasks, these actions help teams back away from cumbersome workflows and focus more on code quality. Pick and combine the automations best suited for your analyzer’s unique release requirements, and easily extend the toolbox to cover new scenarios as they arise. | ||
| A centralized collection of reusable GitHub Actions designed to streamline and automate every stage of the analyzer release process. |
There was a problem hiding this comment.
this is mostly just auto-formatting
| ## Automated Releases for Your Repository | ||
|
|
||
| See [here](docs/automated-releases-how-to.md). |
There was a problem hiding this comment.
This is the only new addition in this specific file.
anton-haubner-sonarsource
force-pushed
the
ahbnr/document-analyzer-release-automation
branch
4 times, most recently
from
44bf32d to
ae7afab
Compare
anton-haubner-sonarsource
force-pushed
the
ahbnr/document-analyzer-release-automation
branch
from
ae7afab to
b9c57ab
Compare
SonarQube reviewer guideSummary: Updates README formatting and adds comprehensive automated release setup guide Review Focus: The new documentation file is extensive and contains specific configuration examples, workflow templates, and step-by-step instructions that need verification for accuracy and completeness. Start review at:
|
SonarQube reviewer guideImportant We are currently testing different models for AI Summary. Model A:Summary: Add documentation for automated release workflow setup and format README for readability. Review Focus: The new how-to guide covers Vault secrets, Jira sandbox setup, and 5-phase implementation workflow. Verify technical accuracy of prerequisites and workflow integration steps. Start review at: Model B:Summary: Add comprehensive documentation for implementing automated releases using reusable GitHub Actions workflows, plus minor README formatting improvements. Review Focus: The new Start review at:
|
| ## About Reusable Workflows | ||
|
|
||
| This guide presents a **reusable workflow pattern**: | ||
|
|
||
| * We will build a shared workflow (like [`abd-automated-release.yml`](../.github/workflows/abd-automated-release.yml)) that multiple | ||
| repositories can call with repository-specific configuration | ||
| * Ideal when multiple projects share similar release processes (e.g., ABD squad repos) | ||
| * For unique requirements, you can instead fully define workflows within your repository using the individual actions from this repository |
There was a problem hiding this comment.
TODO: Get rid of this - point to the new automated analyzer release workflow readme
| In this phase we will add workflows to check releasability, to update metadata, to bump analyzer versions, etc. | ||
| If your repository already contains some of these workflows, double-check that they match the requirements below. | ||
|
|
||
| #### 1.1 Releasability Status |
There was a problem hiding this comment.
TODO: Compare what parts of this are covered by the new workflow.
If something is not covered, and could be useful, then propose to add it to the new workflow.
Otherwise, drop it.
| The branch input must be passed on to the `sonarsource/gh-action-lt-backlog/ToggleLockBranch` action as a `branch_pattern` parameter. | ||
| See the given example. | ||
|
|
||
| #### 1.5 Release Action |
There was a problem hiding this comment.
Keep this
|
|
||
| [//]: # (@formatter:on) | ||
|
|
||
| ### Phase 2: Create Placeholder Workflow |
There was a problem hiding this comment.
Drop this
| run: echo "Testing workflow inputs" | ||
| ``` | ||
|
|
||
| ### Phase 3: Create Your Reusable Workflow |
There was a problem hiding this comment.
Drop this
There was a problem hiding this comment.
Double check, if we have some examples here, or comments inside the workflows that could be added to the new action.
| Hence, study the workflow and adapt it as needed. | ||
| * Upload your changes as a PR. You do not need to get it merged before you are done testing everything. | ||
|
|
||
| ### Phase 4: Integrate with Reusable Workflow |
There was a problem hiding this comment.
same as above
| the parameter names are slightly different. | ||
| 4. Create a PR on your project with your changes. | ||
|
|
||
| ### Phase 5: Test and Refine |
There was a problem hiding this comment.
Keep. See if adaptations are required
1 participant
GHA-123