Merge pull request #655 from Checkmarx/other/benalvo/add-notify-step

other/benalvo/add-notify-step

.github/workflows/release.yml

@@ -1,21 +1,64 @@
-name: Azure AST plugin release
+name: Release Creation
 
 on:
-  push:
-    tags:
-      - "*"
-
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Release tag'
+        required: true
+        type: string
+      dev:
+        description: 'Is dev build'
+        required: false
+        default: true
+        type: boolean
+      publisherID:
+        description: 'Enter Publisher ID (ignore if not Dev release)'
+        required: false
+        type: string       
+
 env:
   PUBLISHER: Checkmarx
-  EXTENSION_ID: checkmarx-ast-azure-plugin
 
 jobs:
-  build:
+  release:
     runs-on: ubuntu-latest
+    outputs:
+      CLI_VERSION: ${{ steps.extract_cli_version.outputs.CLI_VERSION }}
+      TAG_NAME: ${{ steps.set_tag_name.outputs.TAG_NAME }}
 
     steps:
       - uses: actions/checkout@v4
 
+      - name: Set Extension and Publisher ID
+        run: |
+          if [ "${{ inputs.dev }}" == "true" ]; then
+            echo "EXTENSION_ID=checkmarx-ast-azure-plugin-dev" >> $GITHUB_ENV
+            if [ -n "${{ inputs.publisherID }}" ]; then
+            echo "PUBLISHER_ID=${{ inputs.publisherID }}" >> $GITHUB_ENV
+          else
+            echo "EXTENSION_ID=checkmarx-ast-azure-plugin" >> $GITHUB_ENV
+          fi
+      
+      - name: Set Publisher ID
+        run: |
+          if [ "${{ inputs.dev }}" == "true" ]; then
+            echo "PUBLISHER_ID=checkmarx-dev" >> $GITHUB_ENV
+          fi
+        
+      - name: Tag
+        id: set_tag_name
+        run: |
+          echo ${{ inputs.tag }}
+          tag=${{ inputs.tag }}
+          echo "RELEASE_VERSION=${{ inputs.tag }}" >> $GITHUB_ENV
+          message='${{ inputs.tag }}'
+          git config user.name "${GITHUB_ACTOR}"
+          git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+          git tag -a "${tag}" -m "${message}"
+          git push origin "${tag}"
+          echo "::set-output name=TAG_NAME::${{ inputs.tag }}"
+
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/[email protected]
         with:
@@ -37,68 +80,76 @@ jobs:
 
       - name: Set new version
         run: |
-          echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+          echo "RELEASE_VERSION=${{inputs.tag}}" >> $GITHUB_ENV
 
       - name: Set major, minor, patch values
         run: |
-          echo "MAJOR_VERSION=$(echo ${{ env.RELEASE_VERSION }} | cut -d. -f1)" >> $GITHUB_ENV
-          echo "MINOR_VERSION=$(echo ${{ env.RELEASE_VERSION }} | cut -d. -f2)" >> $GITHUB_ENV
-          echo "PATCH_VERSION=$(echo ${{ env.RELEASE_VERSION }} | cut -d. -f3)" >> $GITHUB_ENV
+          CLEAN_VERSION=$(echo ${{ env.RELEASE_VERSION }} | grep -Eo '^[0-9]+\.[0-9]+\.[0-9]+')
+          echo "CLEAN_VERSION=$CLEAN_VERSION" >> $GITHUB_ENV
 
+          echo "MAJOR_VERSION=$(echo $CLEAN_VERSION | cut -d. -f1)" >> $GITHUB_ENV
+          echo "MINOR_VERSION=$(echo $CLEAN_VERSION | cut -d. -f2)" >> $GITHUB_ENV
+          echo "PATCH_VERSION=$(echo $CLEAN_VERSION | cut -d. -f3)" >> $GITHUB_ENV
+      
       - name: New version
         run: |
           echo "The new version is ${{ env.RELEASE_VERSION }}"
           echo "The new major version is ${{ env.MAJOR_VERSION }}"
           echo "The new minor version is ${{ env.MINOR_VERSION }}"
           echo "The new patch version is ${{ env.PATCH_VERSION }}"
 
+      - name: Extract CLI version
+        id: extract_cli_version
+        run: |
+          ls -la
+          pwd
+          CLI_VERSION=$(cat ./cxAstScan/node_modules/@checkmarxdev/ast-cli-javascript-wrapper-runtime-cli/checkmarx-ast-cli.version | grep -Eo '^[0-9]+\.[0-9]+\.[0-9]+')
+          echo "CLI version being packed is $CLI_VERSION"
+          echo "CLI_VERSION=$CLI_VERSION" >> $GITHUB_ENV
+          echo "::set-output name=CLI_VERSION::$CLI_VERSION"
+      
       - name: Set versions in files
         run: |
-          cat <<< $(jq ".version = \"${{ env.RELEASE_VERSION }}\"" ./vss-extension.json) > ./vss-extension.json
+          cat <<< $(jq ".version = \"${{ env.CLEAN_VERSION }}\"" ./vss-extension.json) > ./vss-extension.json
           cat <<< $(jq ".version = \"${{ env.RELEASE_VERSION }}\"" ./package.json) > ./package.json
           cat <<< $(jq ".version.Major = ${{ env.MAJOR_VERSION }}" ./cxAstScan/task.json) > ./cxAstScan/task.json
           cat <<< $(jq ".version.Minor = ${{ env.MINOR_VERSION }}" ./cxAstScan/task.json) > ./cxAstScan/task.json
           cat <<< $(jq ".version.Patch = ${{ env.PATCH_VERSION }}" ./cxAstScan/task.json) > ./cxAstScan/task.json
-
+      
+      - name: Set ID public and publisher fields if dev release
+        run: |
+          if [ "${{ inputs.dev }}" == "true" ]; then
+            cat <<< $(jq ".public = false" vss-extension.json) > vss-extension.json
+            cat <<< $(jq ".id = \"${{ env.EXTENSION_ID }}\"" vss-extension.json) > vss-extension.json
+            cat <<< $(jq ".publisher = \"${{ inputs.publisherID }}\"" vss-extension.json) > vss-extension.json
+          fi
+          
       - name: Create extension
-        run: tfx extension create --manifest-globs vss-extension.json
+        run: tfx extension create --manifest-globs vss-extension.json        
 
       # Create the release
       - name: Create Release
         uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191 #v2.0.8 - Check for the latest version and updated here if there is a new one
         with:
           release_name: Checkmarx Azure ${{ env.RELEASE_VERSION }}
           tag_name: ${{ env.RELEASE_VERSION }}
-          files: ./${{ env.PUBLISHER }}.${{ env.EXTENSION_ID }}-${{ env.RELEASE_VERSION }}.vsix
+          files: ./${{ env.PUBLISHER }}.${{ env.EXTENSION_ID }}-${{ env.CLEAN_VERSION }}.vsix
           generate_release_notes: true
+          prerelease: ${{ inputs.dev }}
 
       - name: Release to marketplace
+        if: inputs.dev == 'false'
         run: tfx extension publish --vsix *.vsix --token ${{ secrets.AZURETOKEN }}
 
-      - name: Get latest release notes
-        id: release
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          body_release="$(gh api -H "Accept: application/vnd.github.v3+json" /repos/Checkmarx/ast-azure-plugin/releases/latest | jq -r '.body' )"
-          body_release="${body_release//$'\n'/'%0A'}"
-          echo "::set-output name=body_release::$body_release"
-      - name: Converts Markdown to HTML
-        id: convert
-        uses: lifepal/markdown-to-html@253bbd85fbdeafe2d1f18c1b9289be24e5cf8f8f #v1.2
-        with:
-          text: "${{ steps.release.outputs.body_release }}"
-
-      - name: Clean html
-        id: clean
-        run: |
-          clean="$(echo "${{ steps.convert.outputs.html }}" | awk '{gsub(/id=.[a-z]+/,"");print}' | tr -d '\n')"
-          echo "$clean"
-          echo "::set-output name=clean::$clean"
-          
-      - name: Send a Notification
-        id: notify
-        uses: thechetantalwar/teams-notify@8a78811f5e8f58cdd204efebd79158006428c46b #v2
-        with:
-          teams_webhook_url: ${{ secrets.TEAMS_WEBHOOK_URI }}
-          message: "<h1>Checkmarx Azure Plugin ${{ env.RELEASE_VERSION }}</h1>${{ steps.clean.outputs.clean }}"
+  notify:
+    if: inputs.dev == false
+    needs: release
+    uses: Checkmarx/plugins-release-workflow/.github/workflows/release-notify.yml@main
+    with:
+      product_name: Azure Plugin
+      release_version: ${{ needs.release.outputs.TAG_NAME }}
+      cli_release_version: ${{ needs.release.outputs.CLI_VERSION }}
+      release_author: "Phoenix Team"
+      release_url: https://github.com/Checkmarx/ast-azure-plugin/releases/tag/${{ needs.release.outputs.TAG_NAME }}
+      jira_product_name: ADO
+    secrets: inherit