GHA-191 Add bump version functionality to automated release workflow (#99)

Author: nils-werner-sonarsource

.claude/skills/automated-release-setup/SKILL.md

@@ -26,6 +26,8 @@ Ask the user for the following details using AskUserQuestion:
    - **SLVSCode** (SonarLint for VS Code)
    - **SLE** (SonarLint for Eclipse)
    - **SLI** (SonarLint for IntelliJ)
+8. **Version Bump**: Whether the automated release workflow should bump the project version after the release (i.e., prepare the next development iteration). If yes, also ask:
+   - **Bump Version PR Labels**: Optional comma-separated list of labels to apply to the version bump pull request (e.g., `update-next-dev,skip-qa`). Leave empty if no labels are needed.
 
 ### Step 1b: Check Existing release.yml
 
@@ -34,6 +36,20 @@ Before asking for all information, read the existing `.github/workflows/release.
 
 This ensures consistency between the release and automated-release workflows.
 
+### Step 1c: Detect Workflow File Extension
+
+Before creating any workflow files, check whether the existing workflows in `.github/workflows/` use `.yml` or `.yaml` as the file extension:
+
+```bash
+ls .github/workflows/
+```
+
+- If most existing files use `.yml`, create new workflow files with the `.yml` extension.
+- If most existing files use `.yaml`, create new workflow files with the `.yaml` extension.
+- If there is a mix, prefer `.yml` (GitHub Actions default).
+
+Apply this detected extension consistently when naming all new workflow files (e.g., `automated-release.yml` or `automated-release.yaml`).
+
 ### Step 2: Check Prerequisites
 
 Remind the user of these prerequisites and **ask for confirmation** using AskUserQuestion:
@@ -59,11 +75,9 @@ Remind the user of these prerequisites and **ask for confirmation** using AskUse
 
 ### Step 3: Create Workflow Files
 
-Create two workflow files in `.github/workflows/`:
-
-#### 3.1 Create `automated-release.yml`
+Create only the `automated-release` workflow file (using the detected extension from Step 1c). **Do not create a separate `bump-versions` workflow** — version bumping is handled directly by the reusable workflow when `bump-version: true` is passed.
 
-**Standard workflow (SQS/SQC only):**
+#### 3.1 Create `automated-release{EXT}` (standard, no SonarLint, no version bump)
 
 ```yaml
 name: Automated Release
@@ -130,19 +144,82 @@ jobs:
       verbose: ${{ github.event.inputs.verbose == 'true' }}
       use-jira-sandbox: ${{ github.event.inputs.dry-run == 'true' }}
       is-draft-release: ${{ github.event.inputs.dry-run == 'true' }}
+```
+
+#### 3.2 Create `automated-release{EXT}` (standard, no SonarLint, **with version bump**)
 
-  bump_versions:
-    name: Bump versions
-    needs: release
-    uses: ./.github/workflows/bump-versions.yaml
+When the user wants version bumping, add `bump-version: true` (and optionally `bump-version-pr-lables`) to the `with:` block:
+
+```yaml
+name: Automated Release
+on:
+  workflow_dispatch:
+    inputs:
+      short-description:
+        description: "Short description for the REL ticket"
+        required: true
+        type: string
+      sqc-integration:
+        description: "Integrate into SQC"
+        type: boolean
+        default: true
+      sqs-integration:
+        description: "Integrate into SQS"
+        type: boolean
+        default: true
+      branch:
+        description: "Branch from which to do the release"
+        required: true
+        default: "master"
+        type: string
+      new-version:
+        description: "New version to release (without -SNAPSHOT; if left empty, the current minor version will be auto-incremented)"
+        required: false
+        type: string
+      rule-props-changed:
+        description: >
+          "@RuleProperty" changed? See SC-4654
+        type: boolean
+        default: false
+      verbose:
+        description: "Enable verbose logging"
+        type: boolean
+        default: false
+      dry-run:
+        description: "Test mode: uses Jira sandbox and creates draft GitHub release"
+        type: boolean
+        default: false
+
+jobs:
+  release:
+    name: Release
+    uses: SonarSource/release-github-actions/.github/workflows/automated-release.yml@v1
     permissions:
+      statuses: read
+      id-token: write
       contents: write
+      actions: write
       pull-requests: write
     with:
-      version: ${{ needs.release.outputs.new-version }}
+      project-name: "${PROJECT_NAME}"
+      plugin-name: "${PLUGIN_NAME}"
+      jira-project-key: "${JIRA_PROJECT_KEY}"
+      rule-props-changed: ${{ github.event.inputs.rule-props-changed }}
+      short-description: ${{ github.event.inputs.short-description }}
+      new-version: ${{ github.event.inputs.new-version }}
+      sqc-integration: ${{ github.event.inputs.sqc-integration == 'true' }}
+      sqs-integration: ${{ github.event.inputs.sqs-integration == 'true' }}
+      branch: ${{ github.event.inputs.branch }}
+      pm-email: "${PM_EMAIL}"
+      slack-channel: "${SLACK_CHANNEL}"
+      verbose: ${{ github.event.inputs.verbose == 'true' }}
+      use-jira-sandbox: ${{ github.event.inputs.dry-run == 'true' }}
+      is-draft-release: ${{ github.event.inputs.dry-run == 'true' }}
+      bump-version: true
+      bump-version-pr-lables: "${BUMP_VERSION_PR_LABELS}"  # omit this line if no labels
 ```
 
-**Workflow with SonarLint integration (includes IDE ticket creation):**
+#### 3.3 Create `automated-release{EXT}` (with SonarLint integration, no version bump)
 
 ```yaml
 name: Automated Release
@@ -234,99 +311,11 @@ jobs:
       verbose: ${{ github.event.inputs.verbose == 'true' }}
       use-jira-sandbox: ${{ github.event.inputs.dry-run == 'true' }}
       is-draft-release: ${{ github.event.inputs.dry-run == 'true' }}
-
-  bump_versions:
-    name: Bump versions
-    needs: release
-    uses: ./.github/workflows/bump-versions.yaml
-    permissions:
-      contents: write
-      pull-requests: write
-    with:
-      version: ${{ needs.release.outputs.new-version }}
 ```
 
-#### 3.2 Create `bump-versions.yaml`
-
-**For Maven projects (pom.xml):**
+#### 3.4 Create `automated-release{EXT}` (with SonarLint integration **and** version bump)
 
-```yaml
-name: bump-versions
-on:
-  workflow_call:
-    inputs:
-      version:
-        required: true
-        type: string
-  workflow_dispatch:
-    inputs:
-      version:
-        description: The new version (without -SNAPSHOT)
-        required: true
-        type: string
-
-jobs:
-  bump-version:
-    runs-on: sonar-xs
-    permissions:
-      contents: write
-      pull-requests: write
-    steps:
-      - uses: actions/checkout@v4
-      - env:
-          VERSION: "${{ inputs.version }}-SNAPSHOT"
-        run: |
-          find . -type f -name "pom.xml" -exec sed -i "s/<version>.*-SNAPSHOT<\/version>/<version>${VERSION}<\/version>/" {} +
-      - uses: peter-evans/create-pull-request@v7
-        with:
-          author: ${{ github.actor }} <${{ github.actor }}>
-          commit-message: Prepare next development iteration
-          title: Prepare next development iteration
-          branch: bot/bump-project-version
-          branch-suffix: timestamp
-          base: master
-          reviewers: ${{ github.actor }}
-```
-
-**For Gradle projects (gradle.properties):**
-
-```yaml
-name: bump-versions
-on:
-  workflow_call:
-    inputs:
-      version:
-        required: true
-        type: string
-  workflow_dispatch:
-    inputs:
-      version:
-        description: The new version (without -SNAPSHOT)
-        required: true
-        type: string
-
-jobs:
-  bump-version:
-    runs-on: sonar-xs
-    permissions:
-      contents: write
-      pull-requests: write
-    steps:
-      - uses: actions/checkout@v4
-      - env:
-          VERSION: "${{ inputs.version }}-SNAPSHOT"
-        run: |
-          sed -i "s/version=.*-SNAPSHOT/version=${VERSION}/" gradle.properties
-      - uses: peter-evans/create-pull-request@v7
-        with:
-          author: ${{ github.actor }} <${{ github.actor }}>
-          commit-message: Prepare next development iteration
-          title: Prepare next development iteration
-          branch: bot/bump-project-version
-          branch-suffix: timestamp
-          base: master
-          reviewers: ${{ github.actor }}
-```
+Add `bump-version: true` (and optionally `bump-version-pr-lables`) to the SonarLint variant's `with:` block, same as in 3.2.
 
 ### Step 4: Update release.yml
 
@@ -382,15 +371,14 @@ After creating/modifying all workflow files, create a branch and commit the chan
 # Create a new branch
 git checkout -b add-automated-release-workflow
 
-# Stage the workflow files
-git add .github/workflows/automated-release.yml .github/workflows/bump-versions.yaml .github/workflows/release.yml
+# Stage the workflow files (use the correct extension detected in Step 1c)
+git add .github/workflows/automated-release.yml .github/workflows/release.yml
 
 # Commit with descriptive message
 git commit -m "Add automated release workflow
 
-Add workflows for automated release process:
+Add workflow for automated release process:
 - automated-release.yml: Main workflow that orchestrates the release
-- bump-versions.yaml: Bumps version file after release
 - Update release.yml to support workflow_dispatch for automated releases
 "
 ```
@@ -460,7 +448,7 @@ Provide these instructions to the user:
 ### Step 7: Post-Release Checklist
 
 Remind user of post-release tasks:
-- Review and merge the bump-version PR
+- Review and merge the bump-version PR (if version bumping was enabled)
 - Review and merge the SQS PR in sonar-enterprise
 - Review and merge the SQC PR in sonarcloud-core
 - Update integration ticket statuses in Jira
@@ -504,4 +492,4 @@ The `sq-ide-short-description` input is used as the description for all IDE tick
 
 - Setup Guide: https://github.com/SonarSource/release-github-actions/blob/master/docs/SETUP_AUTOMATED_RELEASE.md
 - Workflow Documentation: https://github.com/SonarSource/release-github-actions/blob/master/docs/AUTOMATED_RELEASE.md
-- Example: https://github.com/SonarSource/sonar-abap/blob/master/.github/workflows/automated-release.yml
+- Example: https://github.com/SonarSource/sonar-abap/blob/master/.github/workflows/automated-release.yml

.github/workflows/automated-release.yml

@@ -130,6 +130,19 @@ on:
         required: false
         type: string
         default: "Feature,False Positive,False Negative,Bug,Security"
+      bump-version:
+        description: "Whether to bump the version after the release. If false, the workflow will just output the next version without modifying any files."
+        required: false
+        type: boolean
+        default: false
+      bump-version-pr-lables:
+        description: "Labels to apply to the version bump pull request if bump-version is true. For example, 'update-next-dev,skip-qa'."
+        required: false
+        type: string
+      bump-version-exlusions:
+        description: "Comma-separated list of module to exclude from the version bump commit."
+        required: false
+        type: string
 
     outputs:
       new-version:
@@ -458,6 +471,25 @@ jobs:
           echo "### Results" >> $GITHUB_STEP_SUMMARY
           echo "- New Jira version: \`${{ steps.create-jira-version.outputs.jira-new-version-name }}\`." >> $GITHUB_STEP_SUMMARY
 
+  # This step bumps the version in the codebase and creates a pull request for the next development iteration.
+  bump-version:
+    name: Bump Version
+    needs: [ release-in-jira ]
+    if: ${{ inputs.bump-version }}
+    runs-on: ${{ inputs.runner-environment }}
+    permissions:
+      id-token: write
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Bump version and create PR
+        uses: SonarSource/release-github-actions/bump-version@v1
+        with:
+          version: ${{ needs.release-in-jira.outputs.new-version }}
+          pr-labels: ${{ inputs.bump-version-pr-lables }}
+          excluded-modules: ${{ inputs.bump-version-exlusions }}
+          base-branch: ${{ inputs.branch }}
+
   # This step creates integration tickets in various Jira projects based on the inputs provided.
   # It creates tickets for SLVS, SLVSCODE, SLE, SLI, SQC, and SQS as specified.
   # It outputs the integration ticket keys for SQC and SQS for further use.