SONARIAC-2113 Add "Check Releasability" Github Action (#4)

* add 'Check releasability status' action

* add readme

* fix review issues

Author: yasen-pavlov-sonarsource

README.md

@@ -4,4 +4,5 @@ A centralized collection of reusable GitHub Actions designed to streamline and a
 
 ## Available Actions
 
-* [**Create Jira Release Ticket**](create-jira-release-ticket/README.md): Automates the creation of an "Ask for release" ticket in Jira.
+* [**Create Jira Release Ticket**](create-jira-release-ticket/README.md): Automates the creation of an "Ask for release" ticket in Jira.
+* [**Check Releasability Status**](check-releasability-status/README.md): Checks the releasability status of the master branch and extracts the version if successful.

check-releasability-status/README.md

@@ -0,0 +1,57 @@
+# 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.
+
+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.
+
+## Inputs
+
+The following inputs can be configured for the action:
+
+| Input          | Description                        | Required | Default                  |
+|----------------|------------------------------------|----------|--------------------------|
+| `check-name`   | The name of the check run to find. | `false`  | `'Releasability status'` |
+| `github-token` | The GitHub token for API calls.    | `true`   | `${{ github.token }}`    |
+
+## Outputs
+
+| Output    | Description                                                                                                     |
+|-----------|-----------------------------------------------------------------------------------------------------------------|
+| `version` | The extracted version string from the check annotation if the check was successful and an annotation was found. |
+
+## 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.
+
+```yaml
+name: Check Releasability and Use Version
+
+on:
+  workflow_dispatch:
+
+jobs:
+  check_releasability:
+    name: Check Releasability Status
+    runs-on: ubuntu-latest
+    outputs:
+      release_version: ${{ steps.check_status.outputs.version }}
+
+    steps:
+      - name: Check Releasability Status
+        id: check_status
+        uses: SonarSource/release-github-actions/check-releasability-status@master
+
+  use_the_version:
+    name: Use the Extracted Version
+    runs-on: ubuntu-latest
+    needs: check_releasability
+
+    steps:
+      - name: Echo the version
+        if: needs.check_releasability.outputs.release_version
+        run: |
+          echo "The releasable version is ${{ needs.check_releasability.outputs.release_version }}"

check-releasability-status/action.yml

@@ -0,0 +1,84 @@
+name: 'Check releasability status'
+description: 'Gets the status of the latest releasability check on the master branch and returns the version if it succeeded.'
+
+inputs:
+  check-name:
+    description: 'The name of the check run to find.'
+    required: false
+    default: 'Releasability status'
+  github-token:
+    description: 'The GitHub token for API calls.'
+    required: true
+    default: ${{ github.token }}
+
+outputs:
+  version:
+    description: 'The extracted version string from the check annotation.'
+    value: ${{ steps.check_releasability_script.outputs.version }}
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Check releasability status
+      id: check_releasability_script
+      uses: actions/github-script@v7
+      with:
+        github-token: ${{ inputs.github-token }}
+        script: |
+          const { owner, repo } = context.repo;
+          const check_name = '${{ inputs.check-name }}';
+
+          console.log(`Searching for check runs on the "master" branch.`);
+          const { data: { check_runs } } = await github.rest.checks.listForRef({
+            owner,
+            repo,
+            ref: 'master',
+            per_page: 50
+          });
+
+          console.log(`Filtering for the first non-skipped check named "${check_name}".`);
+          const targetCheck = check_runs.find(check => check.name === check_name && check.conclusion !== 'skipped');
+
+          if (!targetCheck) {
+            core.setFailed(`Could not find a recent, non-skipped check named "${check_name}" on the master branch.`);
+            return;
+          }
+
+          console.log(`Found latest relevant check run #${targetCheck.id} (Conclusion: ${targetCheck.conclusion}) on commit ${targetCheck.head_sha}.`);
+
+          if (targetCheck.conclusion !== 'success') {
+            core.setFailed(`The check run "${check_name}" did not succeed. Conclusion: ${targetCheck.conclusion}.`);
+            return;
+          }
+
+          console.log('Check was successful. Fetching annotations...');
+          const { data: annotations } = await github.rest.checks.listAnnotations({
+            owner,
+            repo,
+            check_run_id: targetCheck.id
+          });
+
+          if (annotations.length === 0) {
+            core.setFailed('Found the successful check, but it has no annotations.');
+            return;
+          }
+          
+          const firstAnnotation = annotations[0];
+
+          if (firstAnnotation.annotation_level === 'failure') {
+            core.setFailed(`The check annotation indicates a failure: "${firstAnnotation.message}"`);
+            return;
+          }
+
+          const annotationMessage = firstAnnotation.message;
+          console.log(`Found annotation message: "${annotationMessage}"`);
+
+          const match = annotationMessage.match(/of ([\d\.]+)/);
+          if (!match || !match[1]) {
+            core.setFailed(`Could not parse version from annotation message: "${annotationMessage}"`);
+            return;
+          }
+
+          const version = match[1];
+          console.log(`✅ Extracted version from annotation: ${version}`);
+          core.setOutput('version', version);