Merge pull request #737 from JetBrains/develop.ra/cicd

Add build workflow

.github/workflows/build.yml

@@ -0,0 +1,316 @@
+# GitHub Actions Workflow is created for testing and preparing the plugin release in the following steps:
+# - validate Gradle Wrapper,
+# - run 'verifyPlugin' tasks,
+# - run 'buildPlugin' task and prepare artifact for the further tests,
+# - run 'runPluginVerifier' task,
+# - create a draft release.
+#
+# Workflow is triggered on push and pull_request events.
+#
+# GitHub Actions reference: https://help.github.com/en/actions
+#
+## JBIJPPTPL
+
+name: Build
+on:
+  workflow_dispatch:
+  # Trigger the workflow on pushes to only the 'main' branch (this avoids duplicate checks being run e.g. for dependabot pull requests)
+  push:
+    branches: [ develop ]
+  # Trigger the workflow on any pull request
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+
+  # Prepare environment and build the plugin
+  build-dependencies:
+    name: Build Dependencies
+    runs-on: ubuntu-latest
+    steps:
+
+      # Check out Maven Plugins for Azure Services repository
+      - name: Fetch Maven Plugins for Azure Services
+        uses: actions/checkout@v4
+        with:
+          repository: microsoft/azure-maven-plugins
+          ref: endgame-202310
+          path: azure-maven-plugins
+
+      # Check out current repository
+      - name: Fetch Sources
+        uses: actions/checkout@v4
+        with:
+          path: azure-tools-for-intellij
+
+      # Setup Java environment
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: zulu
+          java-version: |
+            8
+            17
+
+      # Build Maven Plugins for Azure Services library
+      - name: Build Maven Plugins for Azure Services
+        working-directory: ${{ github.workspace }}/azure-maven-plugins
+        shell: bash
+        run: |
+          export JAVA_HOME=$JAVA_HOME_8_X64
+          ./mvnw install -f azure-toolkit-libs/pom.xml
+
+      # Build Utils library
+      - name: Build Utils
+        working-directory: ${{ github.workspace }}/azure-tools-for-intellij
+        shell: bash
+        run: |
+          export JAVA_HOME=$JAVA_HOME_17_X64
+          ./mvnw install -DskipTests -f Utils/pom.xml
+
+      # Upload azure artifacts
+      - name: Upload azure artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: azure-artifacts
+          path: /home/runner/.m2/repository/com/microsoft/azure/
+          retention-days: 1
+
+      # Upload hdinsight artifacts
+      - name: Upload hdinsight artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: hdinsight-artifacts
+          path: /home/runner/.m2/repository/com/microsoft/hdinsight/
+          retention-days: 1
+
+      # Upload azuretools artifacts
+      - name: Upload azuretools artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: azuretools-artifacts
+          path: /home/runner/.m2/repository/com/microsoft/azuretools/
+          retention-days: 1
+
+  # Prepare environment and build the plugin
+  build:
+    name: Build
+    needs: [ build-dependencies ]
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.properties.outputs.version }}
+      changelog: ${{ steps.properties.outputs.changelog }}
+      pluginVerifierHomeDir: ${{ steps.properties.outputs.pluginVerifierHomeDir }}
+    steps:
+
+      # Download azure artifacts
+      - name: Download library artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: azure-artifacts
+          path: /home/runner/.m2/repository/com/microsoft/azure/
+
+      # Download hdinsight artifacts
+      - name: Download library artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: hdinsight-artifacts
+          path: /home/runner/.m2/repository/com/microsoft/hdinsight/
+
+      # Download azuretools artifacts
+      - name: Download library artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: azuretools-artifacts
+          path: /home/runner/.m2/repository/com/microsoft/azuretools/
+
+      # Check out current repository
+      - name: Fetch Sources
+        uses: actions/checkout@v4
+
+      # Setup Java environment
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: zulu
+          java-version: 17
+
+      # Setup Gradle
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+        with:
+          build-root-directory: ${{ github.workspace }}/PluginsAndFeatures/azure-toolkit-for-rider
+          gradle-home-cache-cleanup: true
+
+      # Setup .NET 8 environment
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '8.x'
+
+      # Set environment variables
+      - name: Export Properties
+        id: properties
+        working-directory: ${{ github.workspace }}/PluginsAndFeatures/azure-toolkit-for-rider
+        shell: bash
+        run: |
+          PROPERTIES="$(./gradlew properties --console=plain -q)"
+          VERSION="$(echo "$PROPERTIES" | grep "^version:" | cut -f2- -d ' ')"
+          CHANGELOG="$(./gradlew getChangelog --unreleased --no-header --console=plain -q)"
+
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "pluginVerifierHomeDir=~/.pluginVerifier" >> $GITHUB_OUTPUT
+
+          echo "changelog<<EOF" >> $GITHUB_OUTPUT
+          echo "$CHANGELOG" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+          ./gradlew listProductsReleases # prepare list of IDEs for Plugin Verifier
+
+      # Build plugin
+      - name: Build plugin
+        working-directory: ${{ github.workspace }}/PluginsAndFeatures/azure-toolkit-for-rider
+        run: ./gradlew buildPlugin
+
+      # Prepare plugin archive content for creating artifact
+      - name: Prepare Plugin Artifact
+        id: artifact
+        working-directory: ${{ github.workspace }}/PluginsAndFeatures/azure-toolkit-for-rider
+        shell: bash
+        run: |
+          cd ./build/distributions
+          FILENAME=`ls *.zip`
+          unzip "$FILENAME" -d content
+
+          echo "filename=${FILENAME:0:-4}" >> $GITHUB_OUTPUT
+
+      # Store already-built plugin as an artifact for downloading
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ steps.artifact.outputs.filename }}
+          path: ${{ github.workspace }}/PluginsAndFeatures/azure-toolkit-for-rider/build/distributions/content/*/*
+
+  # Run plugin structure verification along with IntelliJ Plugin Verifier
+  verify:
+    name: Verify plugin
+    needs: [ build ]
+    runs-on: ubuntu-latest
+    steps:
+
+      # Free GitHub Actions Environment Disk Space
+      - name: Maximize Build Space
+        uses: jlumbroso/free-disk-space@main
+        with:
+          tool-cache: false
+          large-packages: false
+
+      # Download azure artifacts
+      - name: Download library artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: azure-artifacts
+          path: /home/runner/.m2/repository/com/microsoft/azure/
+
+      # Download hdinsight artifacts
+      - name: Download library artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: hdinsight-artifacts
+          path: /home/runner/.m2/repository/com/microsoft/hdinsight/
+
+      # Download azuretools artifacts
+      - name: Download library artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: azuretools-artifacts
+          path: /home/runner/.m2/repository/com/microsoft/azuretools/
+
+      # Check out current repository
+      - name: Fetch Sources
+        uses: actions/checkout@v4
+
+      # Set up Java environment
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: zulu
+          java-version: 17
+
+      # Set up Gradle
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+        with:
+          build-root-directory: ${{ github.workspace }}/PluginsAndFeatures/azure-toolkit-for-rider
+          gradle-home-cache-cleanup: true
+
+      # Setup .NET 8 environment
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '8.x'
+
+      # Cache Plugin Verifier IDEs
+      - name: Setup Plugin Verifier IDEs Cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ needs.build.outputs.pluginVerifierHomeDir }}/ides
+          key: plugin-verifier-${{ hashFiles('PluginsAndFeatures/azure-toolkit-for-rider/build/listProductsReleases.txt') }}
+
+      # Run Verify Plugin task and IntelliJ Plugin Verifier tool
+      - name: Run Plugin Verification tasks
+        working-directory: ${{ github.workspace }}/PluginsAndFeatures/azure-toolkit-for-rider
+        run: ./gradlew runPluginVerifier -Dplugin.verifier.home.dir=${{ needs.build.outputs.pluginVerifierHomeDir }}
+
+      # Collect Plugin Verifier Result
+      - name: Collect Plugin Verifier Result
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: pluginVerifier-result
+          path: ${{ github.workspace }}/PluginsAndFeatures/azure-toolkit-for-rider/build/reports/pluginVerifier
+
+  # Prepare a draft release for GitHub Releases page for the manual verification
+  # If accepted and published, release workflow would be triggered
+  releaseDraft:
+    name: Release draft
+    if: github.event_name != 'pull_request'
+    needs: [ build, test, inspectCode, verify ]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+
+      # Check out current repository
+      - name: Fetch Sources
+        uses: actions/checkout@v4
+
+      # Set up Java environment for the next steps
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: zulu
+          java-version: 17
+
+      # Remove old release drafts by using the curl request for the available releases with a draft flag
+      - name: Remove Old Release Drafts
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh api repos/{owner}/{repo}/releases \
+            --jq '.[] | select(.draft == true) | .id' \
+            | xargs -I '{}' gh api -X DELETE repos/{owner}/{repo}/releases/{}
+
+      # Create a new release draft which is not publicly visible and requires manual acceptance
+      - name: Create Release Draft
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create v${{ needs.build.outputs.version }} \
+            --draft \
+            --title "v${{ needs.build.outputs.version }}" \
+            --notes "$(cat << 'EOM'
+          ${{ needs.build.outputs.changelog }}
+          EOM
+          )"