Changelog update - v0.4.15 (#982) #1057
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 '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: [ main, next_release ] | |
| # Trigger the workflow on any pull request | |
| pull_request: | |
| 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.3.1 | |
| # Setup Java 17 environment for the next steps | |
| - name: Setup Java | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: zulu | |
| java-version: 17 | |
| - name: Cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.cfg') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| # Setup Gradle | |
| - name: Setup Gradle | |
| uses: gradle/actions/setup-gradle@v3 | |
| with: | |
| gradle-home-cache-cleanup: true | |
| gradle-version: 8.6 | |
| # 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)" | |
| echo "version=$VERSION" >> $GITHUB_OUTPUT | |
| echo "name=$NAME" >> $GITHUB_OUTPUT | |
| echo "pluginVerifierHomeDir=~/.pluginVerifier" >> $GITHUB_OUTPUT | |
| echo "changelog<<EOF" >> $GITHUB_OUTPUT | |
| echo "$CHANGELOG" >> $GITHUB_OUTPUT | |
| echo "EOF" >> $GITHUB_OUTPUT | |
| ./gradlew printProductsReleases # 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 | |
| # Upload Kover report to CodeCov | |
| - name: Upload Code Coverage Report | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| files: ${{ github.workspace }}/build/reports/kover/report.xml | |
| fail_ci_if_error: true | |
| env: | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
| # 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/printProductsReleases.txt') }} | |
| # Run Verify Plugin task and IntelliJ Plugin Verifier tool | |
| - name: Run Plugin Verification tasks | |
| run: ./gradlew verifyPlugin -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: pluginVerifier-result | |
| path: ${{ github.workspace }}/build/reports/pluginVerifier | |
| # Run Qodana inspections | |
| - name: Qodana - Code Inspection | |
| uses: JetBrains/qodana-action@v2023.3.2 | |
| with: | |
| args: --source-directory,src,testSrc | |
| # 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/*/* | |
| - name: Setup Python | |
| uses: actions/setup-python@v5.1.0 | |
| with: | |
| python-version: '3.11' | |
| - name: Install Dependencies | |
| run: | | |
| pip install -r requirements.txt | |
| - name: build document | |
| run: | | |
| cp CHANGELOG.md docs | |
| mkdocs build --verbose --clean --strict | |
| # 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 | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| # Check out current repository | |
| - name: Fetch Sources | |
| uses: actions/checkout@v4 | |
| # 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 | |
| )" |