GHA-203 Do not use Jira tickets in integration PRs for draft releases (#108)

Author: tomasz-tylenda-sonarsource

update-analyzer/README.md

@@ -36,7 +36,7 @@ This action depends on:
 | `secret-name`       | Name of the secret for GitHub token to fetch from the vault that has permissions to create pull requests in the target Github repository.                                                                                                                             | `true`   |          |
 | `plugin-artifacts`  | Comma-separated list of plugin artifact names (any `X` in `sonar-X-plugin`) that will be used instead of `plugin-name` when provided.                                                                                                                                 | `false`  |          |
 | `base-branch`       | The base branch for the pull request.                                                                                                                                                                                                                                 | `false`  | `master` |
-| `draft`             | A boolean value (`true`/`false`) to control if the pull request is created as a draft.                                                                                                                                                                                | `false`  | `false`  |
+| `draft`             | A boolean value (`true`/`false`) to control if the pull request is created as a draft. When `true`, the commit message is prefixed with `[DO NOT MERGE]` instead of the ticket key.                                                                                   | `false`  | `false`  |
 | `reviewers`         | A comma-separated list of GitHub usernames to request a review from (e.g., `user1,user2`).                                                                                                                                                                            | `false`  |          |
 | `pull-request-body` | The body of the pull request.                                                                                                                                                                                                                                         | `false`  |          |
 

update-analyzer/action.yml

@@ -23,7 +23,7 @@ inputs:
     required: false
     default: 'master'
   draft:
-    description: 'A boolean value to control if the pull request is created as a draft.'
+    description: 'A boolean value to control if the pull request is created as a draft. It also implies DO NOT MERGE'
     required: false
     default: 'false'
   reviewers:
@@ -51,18 +51,27 @@ runs:
     - name: Set up environment
       id: setup_env
       shell: bash
+      env:
+        TICKET_KEY: ${{ inputs.ticket-key }}
+        DRAFT: ${{ inputs.draft }}
       run: |
-        if [[ "${{ inputs.ticket-key }}" == SONAR-* ]]; then
+        if [[ "$TICKET_KEY" == SONAR-* ]]; then
           echo "PRODUCT_REPOSITORY=sonar-enterprise" >> $GITHUB_ENV
           echo "BUILD_GRADLE_FILE=build.gradle" >> $GITHUB_ENV
-        elif [[ "${{ inputs.ticket-key }}" == SC-* ]]; then
+        elif [[ "$TICKET_KEY" == SC-* ]]; then
           echo "PRODUCT_REPOSITORY=sonarcloud-core" >> $GITHUB_ENV
           echo "BUILD_GRADLE_FILE=private/edition-sonarcloud/build.gradle" >> $GITHUB_ENV
         else
           echo "::error::Invalid ticket format. Must start with SONAR- or SC-."
           exit 1
         fi
 
+        if [[ "$DRAFT" == "true" ]]; then
+          echo "commit-prefix=[DO NOT MERGE]" >> $GITHUB_OUTPUT
+        else
+          echo "commit-prefix=$TICKET_KEY" >> $GITHUB_OUTPUT
+        fi
+
     - name: Checkout target repository
       uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       with:
@@ -105,8 +114,8 @@ runs:
       uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6.1.0
       with:
         author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
-        commit-message: '${{ inputs.ticket-key }} Update `${{ inputs.plugin-name }}` plugins to version ${{ inputs.release-version }}'
-        title: '${{ inputs.ticket-key }} Update `${{ inputs.plugin-name }}` to version ${{ inputs.release-version }}'
+        commit-message: '${{ steps.setup_env.outputs.commit-prefix }} Update `${{ inputs.plugin-name }}` plugins to version ${{ inputs.release-version }}'
+        title: '${{ steps.setup_env.outputs.commit-prefix }} Update `${{ inputs.plugin-name }}` to version ${{ inputs.release-version }}'
         body: ${{ inputs.pull-request-body }}
         base: ${{ inputs.base-branch }}
         branch: '${{ inputs.plugin-name }}/update-analyzer-${{ inputs.release-version }}'