Output urls for Jira and Github resources in all actions (#12)

* Output urls for jira and github resources in all actions

* add missing closing quotes in yaml example in readme

Author: yasen-pavlov-sonarsource

check-releasability-status/README.md

@@ -1,12 +1,16 @@
 # Check Releasability Status Action
 
-This GitHub Action checks the releasability status of the master branch. If the check was successful, it extracts the version number from its annotation. It's important to note that this action doesn't run the releasability status check itself but rather finds previous runs. The action is designed to be a prerequisite step in a release workflow, ensuring that a version is ready to be released before proceeding.
+This GitHub Action checks the releasability status of the master branch. If the check was successful, it extracts the
+version number from its annotation. It's important to note that this action doesn't run the releasability status check
+itself but rather finds previous runs. The action is designed to be a prerequisite step in a release workflow, ensuring
+that a version is ready to be released before proceeding.
 
 The action is self-contained and uses the `actions/github-script` toolkit to interact with the GitHub Checks API.
 
 ## Prerequisites
 
-The action requires that the workflow has `checks: read` permissions for the `GITHUB_TOKEN` to be able to access the Checks API.
+The action requires that the workflow has `checks: read` permissions for the `GITHUB_TOKEN` to be able to access the
+Checks API.
 
 ## Inputs
 
@@ -25,7 +29,9 @@ The following inputs can be configured for the action:
 
 ## Example Usage
 
-Here is an example of how to use this action in a workflow. This workflow can be triggered manually. The first job checks the releasability status and exposes the found version as an output. A second job then consumes this version to perform a subsequent step, such as creating a release.
+Here is an example of how to use this action in a workflow. This workflow can be triggered manually. The first job
+checks the releasability status and exposes the found version as an output. A second job then consumes this version to
+perform a subsequent step, such as creating a release.
 
 ```yaml
 name: Check Releasability and Use Version
@@ -55,3 +61,4 @@ jobs:
         if: needs.check_releasability.outputs.release_version
         run: |
           echo "The releasable version is ${{ needs.check_releasability.outputs.release_version }}"
+```

create-jira-release-ticket/README.md

@@ -1,12 +1,15 @@
 # Create Jira Release Ticket Action
 
-This GitHub Action automates the creation of an "Ask for release" ticket in Jira. It is designed to be used in release workflows to standardize the process of requesting a new software release.
+This GitHub Action automates the creation of an "Ask for release" ticket in Jira. It is designed to be used in release
+workflows to standardize the process of requesting a new software release.
 
 The action is self-contained and uses a Python script to interact with the Jira API.
+
 ## Prerequisites
 
 The action requires that the repository has the `development/kv/data/jira` token configured in vault.
-This can be done using the SPEED self-service portal ([more info](https://xtranet-sonarsource.atlassian.net/wiki/spaces/Platform/pages/3553787989/Manage+Vault+Policy+-+SPEED)).
+This can be done using the SPEED self-service
+portal ([more info](https://xtranet-sonarsource.atlassian.net/wiki/spaces/Platform/pages/3553787989/Manage+Vault+Policy+-+SPEED)).
 
 ## Inputs
 
@@ -34,10 +37,13 @@ The following inputs can be configured for the action:
 |---------------------|--------------------------------------------------|
 | `ticket_key`        | The key of the Jira ticket (e.g., `REL-1234`).   |
 | `jira_release_name` | The name of the Jira release used by the action. |
+| `ticket_url`        | The URL of the created Jira ticket.              |
+| `release_url`       | The URL of the Jira release page.                |
 
 ## Example Usage
 
-Here is an example of how to use this action in a workflow. This job will be triggered manually and will create a Jira release ticket using the provided inputs and secrets from HashiCorp Vault.
+Here is an example of how to use this action in a workflow. This job will be triggered manually and will create a Jira
+release ticket using the provided inputs and secrets from HashiCorp Vault.
 
 ```yaml
 name: Create Release Ticket
@@ -49,7 +55,7 @@ env:
 on:
   workflow_dispatch:
     inputs:
-     version:
+      version:
         description: 'Version'
         required: true
         default: '1.0.0'
@@ -101,7 +107,10 @@ jobs:
           jira_release_name: ${{ github.event.inputs.jira_release }}
           sonarlint_changelog: ${{ github.event.inputs.sonarlint_changelog }}
 
-      - name: Echo Ticket Key and Release Name
+      - name: Echo Ticket Details
         run: |
-          echo "The created Jira ticket key is ${{ steps.create_ticket.outputs.ticket_key }}"
-          echo "The Jira release name used is ${{ steps.create_ticket.outputs.jira_release_name }}"
+          echo "Ticket Key: ${{ steps.create_ticket.outputs.ticket_key }}"
+          echo "Ticket URL: ${{ steps.create_ticket.outputs.ticket_url }}"
+          echo "Release Name: ${{ steps.create_ticket.outputs.jira_release_name }}"
+          echo "Release URL: ${{ steps.create_ticket.outputs.release_url }}"
+```

create-jira-release-ticket/action.yml

@@ -55,6 +55,12 @@ outputs:
   jira_release_name:
     description: 'The name of the Jira release found or used by the script.'
     value: ${{ steps.run_python_script.outputs.jira_release_name }}
+  ticket_url:
+    description: 'The URL of the created Jira ticket.'
+    value: ${{ steps.run_python_script.outputs.ticket_url }}
+  release_url:
+    description: 'The URL of the Jira release page.'
+    value: ${{ steps.run_python_script.outputs.release_url }}
 
 runs:
   using: "composite"

create-jira-release-ticket/create_release_ticket.py

@@ -212,10 +212,13 @@ def main():
     eprint(f"   Ticket Key: {ticket.key}")
     eprint(f"   Release Name: {release_notes_info.name}")
     eprint(f"   Ticket URL: {ticket.permalink()}")
+    eprint(f"   Release URL: {release_notes_info.url}")
     eprint("=" * 50)
 
     print(f"ticket_key={ticket.key}")
     print(f"jira_release_name={release_notes_info.name}")
+    print(f"ticket_url={ticket.permalink()}")
+    print(f"release_url={release_notes_info.url}")
 
 
 if __name__ == "__main__":

publish-github-release/README.md

@@ -1,16 +1,21 @@
 # Publish GitHub Release Action
 
-This GitHub Action automates the creation of a GitHub Release. It can generate release notes by fetching the details directly from a Jira release version, or it can use release notes provided directly as an input.
-If not publishing a draft release, the action will wait for the release workflow to complete before reporting its status.
+This GitHub Action automates the creation of a GitHub Release. It can generate release notes by fetching the details
+directly from a Jira release version, or it can use release notes provided directly as an input.
+If not publishing a draft release, the action will wait for the release workflow to complete before reporting its
+status.
 
 This action uses the GitHub CLI to create the release and a Python script to interact with the Jira API.
 
 ## Prerequisites
 
-To fetch release notes from Jira, the action requires that the repository has the `development/kv/data/jira` token configured in vault.
-This can be done using the SPEED self-service portal ([more info](https://xtranet-sonarsource.atlassian.net/wiki/spaces/Platform/pages/3553787989/Manage+Vault+Policy+-+SPEED)).
+To fetch release notes from Jira, the action requires that the repository has the `development/kv/data/jira` token
+configured in vault.
+This can be done using the SPEED self-service
+portal ([more info](https://xtranet-sonarsource.atlassian.net/wiki/spaces/Platform/pages/3553787989/Manage+Vault+Policy+-+SPEED)).
 
-The action also requires a `github_token` with `contents: write` permissions to create the release. The default `${{ github.token }}` is usually sufficient.
+The action also requires a `github_token` with `contents: write` permissions to create the release. The default
+`${{ github.token }}` is usually sufficient.
 
 ## Inputs
 
@@ -39,7 +44,8 @@ The following inputs can be configured for the action:
 
 ## Example Usage
 
-Here is an example of how to use this action in a workflow. This job can be triggered manually to publish a new release, with release notes generated from a specified Jira version.
+Here is an example of how to use this action in a workflow. This job can be triggered manually to publish a new release,
+with release notes generated from a specified Jira version.
 
 ```yaml
 name: Publish New Release
@@ -88,3 +94,4 @@ jobs:
 
       - name: Print Release URL
         run: echo "Successfully published release at ${{ steps.publish.outputs.release_url }}"
+```

release-jira-version/README.md

@@ -1,21 +1,26 @@
 # Release Jira Version Action
 
-This GitHub Action automates releasing a version in Jira and then creating a new, subsequent version. It is useful for end-of-release-cycle workflows.
+This GitHub Action automates releasing a version in Jira and then creating a new, subsequent version. It is useful for
+end-of-release-cycle workflows.
 
 ## How It Works
 
-1.  **Finds a Version**: It searches for a Jira version matching the `jira_release_name` input within the specified `project_key`.
-2.  **Releases It**: It marks that version as "released" in Jira, setting the release date to the current day.
-3.  **Creates the Next Version**:
+1. **Finds a Version**: It searches for a Jira version matching the `jira_release_name` input within the specified
+   `project_key`.
+2. **Releases It**: It marks that version as "released" in Jira, setting the release date to the current day.
+3. **Creates the Next Version**:
     - If you provide a `new_version_name`, it creates a new version with that exact name.
-    - If you don't, it attempts to increment the last number of the `jira_release_name` (e.g., `1.5.2` becomes `1.5.3`) and creates a new version with the incremented name.
+    - If you don't, it attempts to increment the last number of the `jira_release_name` (e.g., `1.5.2` becomes `1.5.3`)
+      and creates a new version with the incremented name.
 
 ## Prerequisites
 
 The action requires that the repository has the `development/kv/data/jira` token configured in vault.
-This can be done using the SPEED self-service portal ([more info](https://xtranet-sonarsource.atlassian.net/wiki/spaces/Platform/pages/3553787989/Manage+Vault+Policy+-+SPEED)).
+This can be done using the SPEED self-service
+portal ([more info](https://xtranet-sonarsource.atlassian.net/wiki/spaces/Platform/pages/3553787989/Manage+Vault+Policy+-+SPEED)).
 
-The [Jira API user](https://sonarsource.atlassian.net/jira/people/712020:9dcffe4d-55ee-4d69-b5d1-535c6dbd9cc4)  must have the project role `Administrators` for the target project to manage releases.
+The [Jira API user](https://sonarsource.atlassian.net/jira/people/712020:9dcffe4d-55ee-4d69-b5d1-535c6dbd9cc4)  must
+have the project role `Administrators` for the target project to manage releases.
 
 ## Inputs
 
@@ -36,7 +41,8 @@ The [Jira API user](https://sonarsource.atlassian.net/jira/people/712020:9dcffe4
 
 ## Example Usage
 
-This example demonstrates a manually triggered workflow that releases the provided version and creates a new one in the `SONARIAC` project.
+This example demonstrates a manually triggered workflow that releases the provided version and creates a new one in the
+`SONARIAC` project.
 
 ```yaml
 name: Release Jira Version

update-analyzer/README.md

@@ -1,16 +1,22 @@
 # Update Analyzer Action
 
-This GitHub Action automates the process of updating an analyzer's version within SonarQube or SonarCloud. It checks out the respective product repository, modifies the `build.gradle` file with the new version, and opens a pull request with the changes.
+This GitHub Action automates the process of updating an analyzer's version within SonarQube or SonarCloud. It checks out
+the respective product repository, modifies the `build.gradle` file with the new version, and opens a pull request with
+the changes.
 
-The action determines whether to target SonarQube (`sonar-enterprise`) or SonarCloud (`sonarcloud-core`) based on the prefix of the provided `ticket` number (`SONAR-` or `SC-`).
+The action determines whether to target SonarQube (`sonar-enterprise`) or SonarCloud (`sonarcloud-core`) based on the
+prefix of the provided `ticket` number (`SONAR-` or `SC-`).
 
 ## Prerequisites
 
-The `github-token` provided to the action must have the following permissions for the target repository (e.g., `SonarSource/sonar-enterprise`):
-  * `contents: write`
-  * `pull-requests: write`
+The `github-token` provided to the action must have the following permissions for the target repository (e.g.,
+`SonarSource/sonar-enterprise`):
 
-An example PR how to request a token with those permissions can be found [here](https://github.com/SonarSource/re-terraform-aws-vault/pull/6693).
+* `contents: write`
+* `pull-requests: write`
+
+An example PR how to request a token with those permissions can be
+found [here](https://github.com/SonarSource/re-terraform-aws-vault/pull/6693).
 
 ## Inputs
 
@@ -25,7 +31,6 @@ An example PR how to request a token with those permissions can be found [here](
 | `reviewers`       | A comma-separated list of GitHub usernames to request a review from (e.g., `user1,user2`).  | `false`  |          |
 | `body`            | The body of the pull request.                                                               | `false`  |          |
 
-
 ## Outputs
 
 | Output   | Description                          |
@@ -34,7 +39,9 @@ An example PR how to request a token with those permissions can be found [here](
 
 ## Example Usage
 
-Here is an example of how to use this action in a workflow. This workflow can be triggered manually (`workflow_dispatch`) and uses a secret to provide the required token. The second job demonstrates how to use the `pr-url` output.
+Here is an example of how to use this action in a workflow. This workflow can be triggered manually (
+`workflow_dispatch`) and uses a secret to provide the required token. The second job demonstrates how to use the
+`pr-url` output.
 
 ```yaml
 # .github/workflows/update-my-analyzer.yml
@@ -65,7 +72,7 @@ jobs:
         with:
           secrets: |
             development/github/token/SonarSource-sonar-php-release-automation token | GITHUB_TOKEN;
- 
+
       - name: Update analyzer and create PR
         id: update_step
         uses: SonarSource/release-github-actions/update-analyzer@master
@@ -84,4 +91,5 @@ jobs:
     steps:
       - name: Echo the PR URL
         run: |
-          echo "Pull request created at: ${{ needs.update-analyzer.outputs.pull_request_url }}"
+          echo "Pull request created at: ${{ needs.update-analyzer.outputs.pull_request_url }}"
+```

update-integration-tickets/README.md

@@ -2,12 +2,16 @@
 
 This GitHub Action automates the process of finding and updating Jira integration tickets.
 
-The action finds both a SonarQube (SQS) integration ticket and a SonarCloud (SC) integration ticket by searching for tickets linked to a specified release ticket. It can then optionally update the `fixVersions` field of the found SQS ticket. If updating the `fixVersions` fails (e.g., due to a non-existent version), it will issue a warning without failing the action.
+The action finds both a SonarQube (SQS) integration ticket and a SonarCloud (SC) integration ticket by searching for
+tickets linked to a specified release ticket. It can then optionally update the `fixVersions` field of the found SQS
+ticket. If updating the `fixVersions` fails (e.g., due to a non-existent version), it will issue a warning without
+failing the action.
 
 ## Prerequisites
 
 The action requires that the repository has the `development/kv/data/jira` token configured in vault.
-This can be done using the SPEED self-service portal ([more info](https://xtranet-sonarsource.atlassian.net/wiki/spaces/Platform/pages/3553787989/Manage+Vault+Policy+-+SPEED)).
+This can be done using the SPEED self-service
+portal ([more info](https://xtranet-sonarsource.atlassian.net/wiki/spaces/Platform/pages/3553787989/Manage+Vault+Policy+-+SPEED)).
 
 ## Inputs
 
@@ -23,14 +27,17 @@ This can be done using the SPEED self-service portal ([more info](https://xtrane
 
 ## Outputs
 
-| Output           | Description                                                        |
-|------------------|--------------------------------------------------------------------|
-| `sqs_ticket_key` | The key of the SQS integration ticket that was found.              |
-| `sc_ticket_key`  | The key of the SC integration ticket that was found.               |
+| Output           | Description                                           |
+|------------------|-------------------------------------------------------|
+| `sqs_ticket_key` | The key of the SQS integration ticket that was found. |
+| `sc_ticket_key`  | The key of the SC integration ticket that was found.  |
+| `sqs_ticket_url` | The URL of the SQS integration ticket that was found. |
+| `sc_ticket_url`  | The URL of the SC integration ticket that was found.  |
 
 ## Example Usage
 
-Here is an example of how to use this action in a workflow. This job will be triggered manually, find the linked SQS and SC tickets, and update the SQS ticket's fix versions.
+Here is an example of how to use this action in a workflow. This job will be triggered manually, find the linked SQS and
+SC tickets, and update the SQS ticket's fix versions.
 
 ```yaml
 name: Update Integration Tickets
@@ -71,7 +78,10 @@ jobs:
           release_ticket_key: ${{ github.event.inputs.release_ticket }}
           sqs_fix_versions: ${{ github.event.inputs.fix_versions }}
 
-      - name: Echo Found Ticket Keys
+      - name: Echo Found Ticket Keys and URLs
         run: |
           echo "Found SQS integration ticket: ${{ steps.integration_update.outputs.sqs_ticket_key }}"
+          echo "SQS ticket URL: ${{ steps.integration_update.outputs.sqs_ticket_url }}"
           echo "Found SC integration ticket: ${{ steps.integration_update.outputs.sc_ticket_key }}"
+          echo "SC ticket URL: ${{ steps.integration_update.outputs.sc_ticket_url }}"
+```

update-integration-tickets/action.yml

@@ -35,6 +35,12 @@ outputs:
   sc_ticket_key:
     description: 'The key of the found SC integration ticket.'
     value: ${{ steps.run_python_script.outputs.sc_ticket_key }}
+  sqs_ticket_url:
+    description: 'The URL of the found SQS integration ticket.'
+    value: ${{ steps.run_python_script.outputs.sqs_ticket_url }}
+  sc_ticket_url:
+    description: 'The URL of the found SC integration ticket.'
+    value: ${{ steps.run_python_script.outputs.sc_ticket_url }}
 
 runs:
   using: "composite"

update-integration-tickets/update_integration_tickets.py

@@ -3,7 +3,7 @@
 
 """
 This script finds SQS and SC integration tickets linked to a given release ticket,
-optionally updates the SQS ticket's fix versions, and returns both keys.
+optionally updates the SQS ticket's fix versions, and returns both keys and URLs.
 """
 
 import argparse
@@ -23,7 +23,7 @@ def eprint(*args, **kwargs):
 
 # noinspection DuplicatedCode
 def get_jira_instance(use_sandbox=False):
-    """Initializes and returns a JIRA client instance."""
+    """Initializes and returns a JIRA client instance and the server URL."""
     jira_user = os.environ.get('JIRA_USER')
     jira_token = os.environ.get('JIRA_TOKEN')
 
@@ -36,7 +36,7 @@ def get_jira_instance(use_sandbox=False):
 
     try:
         jira_client = JIRA(jira_url, basic_auth=(jira_user, jira_token))
-        return jira_client
+        return jira_client, jira_url
     except JIRAError as e:
         eprint(f"Error: JIRA authentication failed. Status: {e.status_code}, Response: {e.text}")
         sys.exit(1)
@@ -93,7 +93,7 @@ def main():
 
     args = parser.parse_args()
 
-    jira = get_jira_instance(args.use_sandbox)
+    jira, jira_url = get_jira_instance(args.use_sandbox)
 
     try:
         eprint(f"Fetching release ticket '{args.release_ticket_key}' to find linked issues...")
@@ -108,9 +108,16 @@ def main():
 
     update_sqs_fix_versions(jira, sqs_ticket_key, args.sqs_fix_versions)
 
+    # Construct browse URLs
+    base_url = jira_url.rstrip('/')
+    sqs_ticket_url = f"{base_url}/browse/{sqs_ticket_key}"
+    sc_ticket_url = f"{base_url}/browse/{sc_ticket_key}"
+
     # Output for the GitHub Action
     print(f"sqs_ticket_key={sqs_ticket_key}")
     print(f"sc_ticket_key={sc_ticket_key}")
+    print(f"sqs_ticket_url={sqs_ticket_url}")
+    print(f"sc_ticket_url={sc_ticket_url}")
 
 
 if __name__ == "__main__":