Merge pull request #110 from remotemobprogramming/dependabot/gradle/o… #240
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 created for testing and preparing the plugin release in following steps: | |
| # - validate Gradle Wrapper, | |
| # - run 'test' and 'verifyPlugin' tasks, | |
| # - run ~Qodana~ SonarCloud inspections, | |
| # - 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: | |
| # Trigger the workflow on pushes to only the 'main' branch (this avoids duplicate checks being run e.g. for dependabot pull requests) | |
| push: | |
| branches: | |
| - master | |
| # Trigger the workflow on any pull request | |
| pull_request: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: write-all | |
| 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 }} | |
| steps: | |
| # Free GitHub Actions Environment Disk Space | |
| - name: Maximize Build Space | |
| run: | | |
| sudo rm -rf /usr/share/dotnet | |
| sudo rm -rf /usr/local/lib/android | |
| sudo rm -rf /opt/ghc | |
| # Check out current repository | |
| - name: Fetch Sources | |
| uses: actions/checkout@v4 | |
| # Validate wrapper | |
| - name: Gradle Wrapper Validation | |
| uses: gradle/wrapper-validation-action@v3 | |
| # Setup Java 11 environment for the next steps | |
| - name: Setup Java | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: zulu | |
| java-version: 11 | |
| cache: gradle | |
| # Set environment variables | |
| - name: Export Properties | |
| id: properties | |
| shell: bash | |
| run: | | |
| PROPERTIES="$(./gradlew properties --console=plain -q)" | |
| VERSION="$(echo "$PROPERTIES" | grep "^version:" | cut -f2- -d ' ')" | |
| NAME="$(echo "$PROPERTIES" | grep "^pluginName:" | cut -f2- -d ' ')" | |
| CHANGELOG="$(./gradlew getChangelog --unreleased --no-header --console=plain -q)" | |
| CHANGELOG="${CHANGELOG//'%'/'%25'}" | |
| CHANGELOG="${CHANGELOG//$'\n'/'%0A'}" | |
| CHANGELOG="${CHANGELOG//$'\r'/'%0D'}" | |
| { | |
| echo "version=$VERSION" | |
| echo "name=$NAME" | |
| echo "changelog=$CHANGELOG" | |
| echo "pluginVerifierHomeDir=~/.pluginVerifier" | |
| } >> "$GITHUB_OUTPUT" | |
| ./gradlew listProductsReleases # prepare list of IDEs for Plugin Verifier | |
| # 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-result | |
| path: ${{ github.workspace }}/build/reports/tests | |
| # Collect code coverage | |
| - name: Collect code coverage | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: code-coverage | |
| path: ${{ github.workspace }}/build/reports/jacoco/test/html | |
| # Sonar | |
| - name: SonarCloud Scan | |
| uses: sonarsource/[email protected] | |
| with: | |
| args: > | |
| -Dsonar.projectKey=remotemobprogramming_intellij-mob | |
| -Dsonar.organization=remotemobprogramming | |
| -Dsonar.sources=src/main/kotlin | |
| -Dsonar.exclusions=*.form,**/resources | |
| -Dsonar.tests=src/test/kotlin | |
| -Dsonar.junit.reportPaths=build/test-results/test/*.xml | |
| -Dsonar.coverage.jacoco.xmlReportPaths=build/reports/jacoco/test/jacocoTestReport.xml | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} | |
| JAVA_HOME: '' # Avoid 'java: not found' error | |
| if: github.repository_owner == 'remotemobprogramming' # Skip because can not read secrets from the public fork | |
| # Cache Plugin Verifier IDEs | |
| - name: Setup Plugin Verifier IDEs Cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ steps.properties.outputs.pluginVerifierHomeDir }}/ides | |
| key: plugin-verifier-${{ hashFiles('build/listProductsReleases.txt') }} | |
| # Run Verify Plugin task and IntelliJ Plugin Verifier tool | |
| - name: Run Plugin Verification tasks | |
| run: ./gradlew runPluginVerifier -Pplugin.verifier.home.dir=${{ steps.properties.outputs.pluginVerifierHomeDir }} | |
| # Collect Plugin Verifier Result | |
| - name: Collect Plugin Verifier Result | |
| if: ${{ always() }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: pluginVerifier-result | |
| path: ${{ github.workspace }}/build/reports/pluginVerifier | |
| # 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:2:-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/*/* | |
| # Notification | |
| - uses: 8398a7/action-slack@v3 | |
| with: | |
| status: ${{ job.status }} | |
| fields: repo,message,job,pullRequest | |
| mention: here | |
| if_mention: failure | |
| env: | |
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # required | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # optional | |
| if: always() # Pick up events even if the job fails or is canceled. |