Update the plugin verification configuration #465
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # GitHub Actions Workflow is created for testing and preparing the plugin release in the following steps: | |
| # - Validate Gradle Wrapper. | |
| # - Run 'test' and 'verifyPlugin' tasks. | |
| # - Run Qodana inspections. | |
| # - Run the 'buildPlugin' task and prepare artifact for further tests. | |
| # - Run the 'runPluginVerifier' task. | |
| # - Create a draft release. | |
| # | |
| # The workflow is triggered on push and pull_request events. | |
| # | |
| # GitHub Actions reference: https://help.github.com/en/actions | |
| ## | |
| name: Build | |
| on: | |
| # Trigger the workflow on pushes to only the 'main' branch (this avoids duplicate checks being run e.g., for dependabot pull requests) | |
| push: | |
| branches: | |
| - 'v3.6/213' | |
| paths-ignore: | |
| - '.idea/**' | |
| - '.run/**' | |
| - 'art/**' | |
| - 'images/**' | |
| - '.gitignore' | |
| - 'README.md' | |
| - 'FINANCIAL_CONTRIBUTORS.md' | |
| # Trigger the workflow on any pull request | |
| pull_request: | |
| paths-ignore: | |
| - '.idea/**' | |
| - '.run/**' | |
| - 'art/**' | |
| - 'images/**' | |
| - '.gitignore' | |
| - 'README.md' | |
| - 'FINANCIAL_CONTRIBUTORS.md' | |
| concurrency: | |
| group: "${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}" | |
| cancel-in-progress: true | |
| jobs: | |
| # Run Gradle Wrapper Validation Action to verify the wrapper's checksum | |
| # Run verifyPlugin, IntelliJ Plugin Verifier, and test Gradle tasks | |
| # Build plugin and provide the artifact for the next workflow jobs | |
| build: | |
| name: Build | |
| runs-on: ubuntu-latest | |
| outputs: | |
| version: ${{ steps.properties.outputs.version }} | |
| changelog: ${{ steps.properties.outputs.changelog }} | |
| pluginVerifierHomeDir: ${{ steps.properties.outputs.pluginVerifierHomeDir }} | |
| steps: | |
| # Check out the current repository | |
| - name: Fetch Sources | |
| uses: actions/checkout@v4 | |
| # Validate wrapper | |
| - name: Gradle Wrapper Validation | |
| uses: gradle/actions/wrapper-validation@v3 | |
| # Set up Java environment for the next steps | |
| - name: Setup Java | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: zulu | |
| java-version: 11 | |
| # Setup Gradle | |
| - name: Setup Gradle | |
| uses: gradle/actions/setup-gradle@v3 | |
| with: | |
| gradle-home-cache-cleanup: true | |
| # Set environment variables | |
| - name: Export Properties | |
| id: properties | |
| env: | |
| AUTO_SNAPSHOT_VERSION: false | |
| shell: bash | |
| run: | | |
| PROPERTIES="$(./gradlew properties --console=plain -q)" | |
| VERSION="$(echo "$PROPERTIES" | grep "^version:" | cut -f2- -d ' ')" | |
| CHANGELOG="$(./gradlew getChangelog --unreleased --no-header --no-links --console=plain -q)" | |
| echo "version: $VERSION" | |
| echo "changelog:" | |
| echo "$CHANGELOG" | |
| 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 | |
| run: ./gradlew buildPlugin | |
| # Prepare plugin archive content for creating artifact | |
| - name: Prepare Plugin Artifact | |
| id: artifact | |
| shell: bash | |
| run: | | |
| cd ${{ github.workspace }}/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@v4 | |
| with: | |
| name: ${{ steps.artifact.outputs.filename }} | |
| path: ./build/distributions/content/*/* | |
| # Run tests and upload a code coverage report | |
| test: | |
| name: Test | |
| needs: [ build ] | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Check out the current repository | |
| - name: Fetch Sources | |
| uses: actions/checkout@v4 | |
| # Set up Java environment for the next steps | |
| - name: Setup Java | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: zulu | |
| java-version: 11 | |
| # Setup Gradle | |
| - name: Setup Gradle | |
| uses: gradle/actions/setup-gradle@v3 | |
| with: | |
| gradle-home-cache-cleanup: true | |
| # Run tests | |
| - name: Run Tests | |
| run: ./gradlew check | |
| # Collect Tests Result of failed tests | |
| - name: Collect Tests Result | |
| if: ${{ failure() }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: tests-report | |
| path: ${{ github.workspace }}/build/reports/tests | |
| ## Upload the Kover report to CodeCov | |
| #- name: Upload Code Coverage Report | |
| # uses: codecov/codecov-action@v4 | |
| # with: | |
| # files: ${{ github.workspace }}/build/reports/kover/report.xml | |
| # Collect Code Coverage Report | |
| - name: Collect Code Coverage Report | |
| if: ${{ always() }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: code-coverage-report | |
| path: ${{ github.workspace }}/build/reports/kover/html | |
| # 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 | |
| # Check out the current repository | |
| - name: Fetch Sources | |
| uses: actions/checkout@v4 | |
| # Set up Java environment for the next steps | |
| - name: Setup Java | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: zulu | |
| java-version: 11 | |
| # Setup Gradle | |
| - name: Setup Gradle | |
| uses: gradle/actions/setup-gradle@v3 | |
| with: | |
| gradle-home-cache-cleanup: true | |
| # Cache Plugin Verifier IDEs | |
| - name: Setup Plugin Verifier IDEs Cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ needs.build.outputs.pluginVerifierHomeDir }}/ides | |
| key: plugin-verifier-${{ hashFiles('build/listProductsReleases.txt') }} | |
| # Run Verify Plugin task and IntelliJ Plugin Verifier tool | |
| - name: Run Plugin Verification tasks | |
| continue-on-error: true | |
| 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@v4 | |
| with: | |
| name: plugin-verifier-report | |
| path: ${{ github.workspace }}/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, verify ] | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| # Check out the current repository | |
| - name: Fetch Sources | |
| uses: actions/checkout@v4 | |
| # Remove old release drafts | |
| - name: Remove Old Release Drafts | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| BRANCH="${{ github.ref_name }}" | |
| gh api repos/{owner}/{repo}/releases \ | |
| --jq ".[] | select(.draft == true and .target_commitish == \"${BRANCH}\") | .id" \ | |
| | xargs -I '{}' gh api -X DELETE repos/{owner}/{repo}/releases/{} | |
| # Create new release draft - which is not publicly visible and requires manual acceptance | |
| - name: Create Release Draft | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| BRANCH="${{ github.ref_name }}" | |
| gh release create v${{ needs.build.outputs.version }} \ | |
| --target "$BRANCH" \ | |
| --draft \ | |
| --title "v${{ needs.build.outputs.version }}" \ | |
| --notes "$(cat << 'EOM' | |
| ## What's Changed | |
| ${{ needs.build.outputs.changelog }} | |
| EOM | |
| )" |