Remove targeted product and sq compat from create rel ticket action (#49)

yasen-pavlov-sonarsource · web-flow · commit afb4e46bc855 · 2025-09-30T19:07:51.000+02:00
diff --git a/.github/workflows/cloud-security-automated-release.yml b/.github/workflows/cloud-security-automated-release.yml
@@ -53,10 +53,6 @@ on:
         description: "Did any rule properties change in this release"
         required: true
         type: string
-      sq-compatibility:
-        description: "SonarQube compatibility"
-        required: true
-        type: string
       branch:
         description: "Branch from which to do the release"
         required: true
@@ -124,7 +120,7 @@ jobs:
         run: |
           echo "::error::Rule metadata changes detected. The generated PR needs to be merged first before continuing with the release."
           echo "::error::Pull Request URL: ${{ steps.update-rule-metadata.outputs.pull-request-url }}"
-          echo "::error::Please merge the PR and restart this workflow."
+          echo "::error::Please merge the PR and run this workflow again (Start a new run instead of re-runing failed jobs in the current one)."
           exit 1
 
   prepare-release:
@@ -175,7 +171,6 @@ jobs:
         with:
           project-name: ${{ inputs.project-name }}
           short-description: ${{ inputs.short-description }}
-          sq-compatibility: ${{ inputs.sq-compatibility }}
           rule-props-changed: ${{ inputs.rule-props-changed }}
           jira-release-url: ${{ needs.prepare-release.outputs.jira-release-url }}
           start-progress: true
@@ -372,5 +367,12 @@ jobs:
           
           if [[ "$ALL_SUCCESS" == "true" ]]; then
             echo "" >> $GITHUB_STEP_SUMMARY
-            echo "PS: Don't forget to review and merge the bump version, SQS and SQC PRs!" >> $GITHUB_STEP_SUMMARY
+            echo "PS: Don't forget to review and merge the bump version, SQS and SQC!" >> $GITHUB_STEP_SUMMARY
+            echo "You should also update the relevant integration ticket statuses (don't forget to set the SQS ticket fix versions!)" >> $GITHUB_STEP_SUMMARY
+            echo "For more information please check the release instructions at:" >> $GITHUB_STEP_SUMMARY
+            echo "https://xtranet-sonarsource.atlassian.net/wiki/spaces/CSD/pages/4325048388/Release+Instructions+-+Cloud+Security" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "" >> $GITHUB_STEP_SUMMARY
+            echo "For fixes to common issues and other useful information please check the release instructions at:" >> $GITHUB_STEP_SUMMARY
+            echo "https://xtranet-sonarsource.atlassian.net/wiki/spaces/CSD/pages/4325048388/Release+Instructions+-+Cloud+Security" >> $GITHUB_STEP_SUMMARY
           fi
diff --git a/.github/workflows/test-create-jira-release-ticket.yml b/.github/workflows/test-create-jira-release-ticket.yml
@@ -61,7 +61,6 @@ jobs:
           project-name: "Test Project"
           version: "1.0.0"
           short-description: "Test release for integration testing"
-          sq-compatibility: "2025.1"
           use-jira-sandbox: true
         continue-on-error: true
 
@@ -101,7 +100,6 @@ jobs:
           project-name: "Test Project"
           version: "1.0.0"
           short-description: "Test release"
-          sq-compatibility: "2025.1"
           jira-release-url: "https://test.jira.com/release/notes"
         continue-on-error: true
 
@@ -124,7 +122,6 @@ jobs:
           project-name: "Test Project"
           version: "1.0.0"
           short-description: "Test release"
-          sq-compatibility: "2025.1"
         continue-on-error: true
 
       - name: Verify Missing Release URL Failure
@@ -147,7 +144,6 @@ jobs:
           project-name: "Test Project"
           version: "1.0.0"
           short-description: "Test release"
-          sq-compatibility: "2025.1"
           jira-release-url: "https://test.jira.com/release/notes"
         continue-on-error: true
 
@@ -173,7 +169,6 @@ jobs:
           project-name: "Test Project"
           version: "1.0.0"
           short-description: "Test release"
-          sq-compatibility: "2025.1"
         continue-on-error: true
 
       - name: Verify Release URL Environment Variable Works
@@ -198,7 +193,6 @@ jobs:
           project-name: "Test Project"
           version: "1.0.0"
           short-description: "Test release"
-          sq-compatibility: "2025.1"
           jira-release-url: "https://input.jira.com/release"
         continue-on-error: true
 
diff --git a/create-jira-release-ticket/README.md b/create-jira-release-ticket/README.md
@@ -25,10 +25,8 @@ This action depends on:
 |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|
 | `project-name`         | The display name of the project (e.g., SonarIaC). Used as the prefix for the release ticket summary                                                                                                             | Yes      | -       |
 | `short-description`    | A short description for the release                                                                                                                                                                             | Yes      | -       |
-| `sq-compatibility`     | SonarQube compatibility version (e.g., 2025.3)                                                                                                                                                                  | Yes      | -       |
 | `jira-project-key`     | The key of the Jira project (e.g., SONARIAC). Can also be set via `JIRA_PROJECT_KEY` environment variable                                                                                                       | No*      | -       |
 | `version`              | The version being released (e.g., 11.44.2), or leave empty to use the release version                                                                                                                           | No       | -       |
-| `targeted-product`     | The targeted product version (e.g., 11.0)                                                                                                                                                                       | No       | -       |
 | `use-jira-sandbox`     | Use the sandbox server instead of the production Jira. Can also be controlled via `USE_JIRA_SANDBOX` environment variable                                                                                       | No       | `false` |
 | `documentation-status` | Status of the documentation                                                                                                                                                                                     | No       | `N/A`   |
 | `rule-props-changed`   | Whether rule properties have changed (`Yes` or `No`)                                                                                                                                                            | No       | `No`    |
@@ -65,7 +63,6 @@ This action depends on:
     project-name: 'SonarIaC'
     version: '11.44.2'
     short-description: 'Bug fixes and performance improvements'
-    sq-compatibility: '2025.3'
     jira-release-url: 'https://sonarsource.atlassian.net/projects/SONARIAC/versions/12345'
 
 - name: Use created ticket
@@ -85,8 +82,6 @@ This action depends on:
   with:
     project-name: 'SonarIaC'
     short-description: 'Major release with new features'
-    sq-compatibility: '2025.3'
-    targeted-product: '11.0'
     rule-props-changed: 'Yes'
 ```
 
@@ -98,7 +93,6 @@ This action depends on:
   with:
     project-name: 'Test Project'
     short-description: 'Beta release for testing'
-    sq-compatibility: '2025.3'
     use-jira-sandbox: 'true'
 ```
 
@@ -110,7 +104,6 @@ This action depends on:
   with:
     project-name: 'SonarIaC'
     short-description: 'Quarterly release'
-    sq-compatibility: '2025.3'
     start-progress: 'true'
 ```
 
@@ -123,7 +116,6 @@ This action depends on:
     jira-project-key: 'SONARIAC'
     project-name: 'SonarIaC'
     short-description: 'Release with environment variable usage'
-    sq-compatibility: '2025.3'
     jira-release-url: 'https://sonarsource.atlassian.net/projects/SONARIAC/versions/12345'
 
 - name: Post to Slack
@@ -156,8 +148,6 @@ The action populates the following Jira custom fields:
 | Field                   | Custom Field ID   | Source Input           |
 |-------------------------|-------------------|------------------------|
 | Short Description       | customfield_10146 | `short-description`    |
-| SonarQube Compatibility | customfield_10148 | `sq-compatibility`     |
-| Targeted Product        | customfield_10163 | `targeted-product`     |
 | Link to Release Notes   | customfield_10145 | `jira-release-url`     |
 | Documentation Status    | customfield_10147 | `documentation-status` |
 | Rule Properties Changed | customfield_11263 | `rule-props-changed`   |
diff --git a/create-jira-release-ticket/action.yml b/create-jira-release-ticket/action.yml
@@ -9,13 +9,8 @@ inputs:
   short-description:
     description: 'A short description for the release'
     required: true
-  sq-compatibility:
-    description: 'SonarQube compatibility version (e.g., 2025.3)'
-    required: true
   jira-project-key:
     description: 'The key of the project (e.g., SONARIAC). Required if JIRA_PROJECT_KEY env var is not set.'
-  targeted-product:
-    description: 'The targeted product version (e.g., 11.0)'
   version:
     description: 'The version being released (e.g., 11.44.2), or leave empty to use the release version.'
   use-jira-sandbox:
@@ -93,8 +88,6 @@ runs:
           --project-name="${{ inputs.project-name }}" \
           --version="${{ inputs.version || env.RELEASE_VERSION }}" \
           --short-description="${{ inputs.short-description }}" \
-          --targeted-product="${{ inputs.targeted-product }}" \
-          --sq-compatibility="${{ inputs.sq-compatibility }}" \
           --jira-url="${{ ((inputs.use-jira-sandbox || env.USE_JIRA_SANDBOX) == 'true') && env.JIRA_SANDBOX_URL || env.JIRA_PROD_URL }}" \
           --documentation-status="${{ inputs.documentation-status }}" \
           --rule-props-changed="${{ inputs.rule-props-changed }}" \
diff --git a/create-jira-release-ticket/create_release_ticket.py b/create-jira-release-ticket/create_release_ticket.py
@@ -13,8 +13,6 @@
 
 CUSTOM_FIELDS = {
     'SHORT_DESCRIPTION': 'customfield_10146',
-    'SQ_COMPATIBILITY': 'customfield_10148',
-    'TARGETED_PRODUCT': 'customfield_10163',
     'LINK_TO_RELEASE_NOTES': 'customfield_10145',
     'DOCUMENTATION_STATUS': 'customfield_10147',
     'RULE_PROPS_CHANGED': 'customfield_11263',
@@ -75,16 +73,12 @@ def create_release_ticket(jira_client, args, link_to_release_notes):
         'issuetype': 'Ask for release',
         'summary': f'{args.project_name} {args.version}',
         CUSTOM_FIELDS['SHORT_DESCRIPTION']: args.short_description,
-        CUSTOM_FIELDS['SQ_COMPATIBILITY']: args.sq_compatibility,
         CUSTOM_FIELDS['LINK_TO_RELEASE_NOTES']: link_to_release_notes,
         CUSTOM_FIELDS['DOCUMENTATION_STATUS']: args.documentation_status,
         CUSTOM_FIELDS['RULE_PROPS_CHANGED']: {'value': args.rule_props_changed},
         CUSTOM_FIELDS['SONARLINT_CHANGELOG']: args.sonarlint_changelog
     }
 
-    if args.targeted_product:
-        ticket_details[CUSTOM_FIELDS['TARGETED_PRODUCT']] = {'value': args.targeted_product}
-
     try:
         new_ticket = jira_client.create_issue(fields=ticket_details)
         return new_ticket
@@ -107,8 +101,6 @@ def main():
     parser.add_argument("--project-name", required=True, help="The display name of the project (e.g., SonarIaC).")
     parser.add_argument("--version", required=True, help="The version being released (e.g., 11.44.2).")
     parser.add_argument("--short-description", required=True, help="A short description for the release.")
-    parser.add_argument("--sq-compatibility", required=True, help="SonarQube compatibility version (e.g., 2025.3).")
-    parser.add_argument("--targeted-product", help="The targeted product version (e.g., 11.0).")
     parser.add_argument("--jira-url", required=True, help="The Jira server URL to connect to.")
     parser.add_argument("--documentation-status", default="N/A", help="Status of the documentation.")
     parser.add_argument("--rule-props-changed", default="No", choices=['Yes', 'No'],
diff --git a/create-jira-release-ticket/test_create_release_ticket.py b/create-jira-release-ticket/test_create_release_ticket.py
@@ -69,11 +69,9 @@ def test_create_release_ticket_with_all_fields(self):
         args.project_name = 'TestProject'
         args.version = '1.2.3'
         args.short_description = 'Test release'
-        args.sq_compatibility = '2025.1'
         args.documentation_status = 'Ready'
         args.rule_props_changed = 'Yes'
         args.sonarlint_changelog = 'Test changelog'
-        args.targeted_product = '11.0'
 
         release_url = 'https://jira.com/release/notes'
 
@@ -88,42 +86,10 @@ def test_create_release_ticket_with_all_fields(self):
         self.assertEqual(call_args['issuetype'], 'Ask for release')
         self.assertEqual(call_args['summary'], 'TestProject 1.2.3')
         self.assertEqual(call_args['customfield_10146'], 'Test release')  # SHORT_DESCRIPTION
-        self.assertEqual(call_args['customfield_10148'], '2025.1')  # SQ_COMPATIBILITY
         self.assertEqual(call_args['customfield_10145'], release_url)  # LINK_TO_RELEASE_NOTES
         self.assertEqual(call_args['customfield_10147'], 'Ready')  # DOCUMENTATION_STATUS
         self.assertEqual(call_args['customfield_11263'], {'value': 'Yes'})  # RULE_PROPS_CHANGED
         self.assertEqual(call_args['customfield_11264'], 'Test changelog')  # SONARLINT_CHANGELOG
-        self.assertEqual(call_args['customfield_10163'], {'value': '11.0'})  # TARGETED_PRODUCT
-
-    def test_create_release_ticket_without_optional_fields(self):
-        """Test creating release ticket without optional fields."""
-        mock_jira = Mock()
-        mock_ticket = Mock()
-        mock_ticket.key = 'REL-124'
-        mock_ticket.permalink.return_value = 'https://jira.com/REL-124'
-        mock_jira.create_issue.return_value = mock_ticket
-
-        # Mock args
-        args = Mock()
-        args.project_name = 'TestProject'
-        args.version = '1.2.3'
-        args.short_description = 'Test release'
-        args.sq_compatibility = '2025.1'
-        args.documentation_status = 'N/A'
-        args.rule_props_changed = 'No'
-        args.sonarlint_changelog = ''
-        args.targeted_product = None
-
-        release_url = 'https://jira.com/release/notes'
-
-        result = create_release_ticket(mock_jira, args, release_url)
-
-        self.assertEqual(result, mock_ticket)
-        mock_jira.create_issue.assert_called_once()
-
-        # Verify the issue creation call - should not include targeted_product
-        call_args = mock_jira.create_issue.call_args[1]['fields']
-        self.assertNotIn('customfield_10163', call_args)  # TARGETED_PRODUCT should not be set
 
     # noinspection DuplicatedCode,PyUnusedLocal
     @patch('create_release_ticket.eprint')
@@ -138,11 +104,9 @@ def test_create_release_ticket_jira_error(self, mock_eprint):
         args.project_name = 'TestProject'
         args.version = '1.2.3'
         args.short_description = 'Test release'
-        args.sq_compatibility = '2025.1'
         args.documentation_status = 'N/A'
         args.rule_props_changed = 'No'
         args.sonarlint_changelog = ''
-        args.targeted_product = None
 
         with self.assertRaises(SystemExit) as cm:
             create_release_ticket(mock_jira, args, 'https://release.url')
@@ -155,7 +119,6 @@ def test_create_release_ticket_jira_error(self, mock_eprint):
         '--project-name', 'Test Project',
         '--version', '1.0.0',
         '--short-description', 'Test release',
-        '--sq-compatibility', '2025.1',
         '--jira-url', 'https://test.jira.com',
         '--jira-release-url', 'https://jira.com/release/notes'
     ])
@@ -200,8 +163,6 @@ def test_main_successful_ticket_creation(self, mock_stderr, mock_stdout, mock_cr
         '--project-name', 'Test Project',
         '--version', '1.0.0',
         '--short-description', 'Test release',
-        '--sq-compatibility', '2025.1',
-        '--targeted-product', '11.0',
         '--jira-url', 'https://sandbox.jira.com',
         '--jira-release-url', 'https://sandbox.jira.com/release/notes',
         '--documentation-status', 'Ready',
@@ -235,8 +196,6 @@ def test_main_with_all_parameters(self, mock_stderr, mock_stdout, mock_create_ti
         self.assertEqual(args.project_name, 'Test Project')
         self.assertEqual(args.version, '1.0.0')
         self.assertEqual(args.short_description, 'Test release')
-        self.assertEqual(args.sq_compatibility, '2025.1')
-        self.assertEqual(args.targeted_product, '11.0')
         self.assertEqual(args.jira_url, 'https://sandbox.jira.com')
         self.assertEqual(args.jira_release_url, 'https://sandbox.jira.com/release/notes')
         self.assertEqual(args.documentation_status, 'Ready')
