update release job #149
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 buildPlugin task and prepare artifact for the further tests, | |
| # - run IntelliJ Plugin Verifier, | |
| # - create a draft release. | |
| # | |
| # Workflow is triggered on push and pull_request events. | |
| # | |
| # Docs: | |
| # - GitHub Actions: https://help.github.com/en/actions | |
| # - IntelliJ Plugin Verifier GitHub Action: https://github.com/ChrisCarini/intellij-platform-plugin-verifier-action | |
| name: Build | |
| on: [push, pull_request] | |
| jobs: | |
| # Run Gradle Wrapper Validation Action to verify the wrapper's checksum | |
| gradleValidation: | |
| name: Gradle Wrapper | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Check out current repository | |
| - name: Fetch Sources | |
| uses: actions/checkout@v4 | |
| # Validate wrapper | |
| - name: Gradle Wrapper Validation | |
| uses: gradle/wrapper-validation-action@v3 | |
| # Run verifyPlugin and test Gradle tasks | |
| test: | |
| name: Test | |
| needs: gradleValidation | |
| env: | |
| SENTRY_DSN: ${{ secrets.SENTRY_DSN }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Check out current repository | |
| - name: Fetch Sources | |
| uses: actions/checkout@v4 | |
| # Setup Java 17 environment for the next steps | |
| - name: Setup Java | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: 'zulu' | |
| java-version: '17' | |
| cache: gradle | |
| # Cache Gradle dependencies | |
| - name: Setup Cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.gradle/caches | |
| key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }} | |
| restore-keys: ${{ runner.os }}-gradle- | |
| # Run detekt | |
| - name: Run Linters | |
| run: ./gradlew check | |
| # Run verifyPlugin Gradle task | |
| - name: Verify Plugin | |
| run: ./gradlew verifyPlugin | |
| # Run test Gradle task | |
| - name: Run Tests | |
| run: ./gradlew test | |
| # Build plugin with buildPlugin Gradle task and provide the artifact for the next workflow jobs | |
| # Requires test job to be passed | |
| build: | |
| name: Build | |
| needs: test | |
| env: | |
| SENTRY_DSN: ${{ secrets.SENTRY_DSN }} | |
| runs-on: ubuntu-latest | |
| outputs: | |
| name: ${{ steps.properties.outputs.name }} | |
| version: ${{ steps.properties.outputs.version }} | |
| artifact: ${{ steps.properties.outputs.pluginName }}-${{ steps.properties.outputs.version }}.zip | |
| changelog: ${{ steps.properties.outputs.changelog }} | |
| steps: | |
| # Check out current repository | |
| - name: Fetch Sources | |
| uses: actions/checkout@v4 | |
| # Setup Java 17 environment for the next steps | |
| - name: Setup Java | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: 'zulu' | |
| java-version: '17' | |
| cache: gradle | |
| # Cache Gradle dependencies | |
| - name: Setup Cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.gradle/caches | |
| key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }} | |
| restore-keys: ${{ runner.os }}-gradle- | |
| # Set environment variables | |
| - name: Export Properties | |
| id: properties | |
| run: | | |
| echo "::set-output name=version::$(./gradlew properties --console=plain -q | grep "^version:" | cut -f2- -d ' ')" | |
| echo "::set-output name=name::$(./gradlew properties --console=plain -q | grep "^name:" | cut -f2- -d ' ')" | |
| echo "::set-output name=pluginName::$(./gradlew properties --console=plain -q | 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 "::set-output name=changelog::$CHANGELOG" | |
| # Build artifact using buildPlugin Gradle task | |
| - name: Build Plugin | |
| run: ./gradlew buildPlugin | |
| # Upload plugin artifact to make it available in the next jobs | |
| - name: Upload artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: plugin-artifact | |
| path: ./build/distributions/${{ needs.build.outputs.artifact }} | |
| # 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 | |
| )" |