2024.2 upgrade using intellijPlatform extension and Remove depricated/scheduled for removal usage #176
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 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] | |
# Trigger the workflow on any pull request | |
pull_request: | |
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 current repository | |
- name: Fetch Sources | |
uses: actions/[email protected] | |
# Validate wrapper | |
- name: Gradle Wrapper Validation | |
uses: gradle/actions/wrapper-validation@v3 | |
# Setup Java 17 environment for the next steps | |
- name: Setup Java | |
uses: actions/setup-java@v4 | |
with: | |
distribution: zulu | |
java-version: 17 | |
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)" | |
echo "::set-output name=version::$VERSION" | |
echo "::set-output name=name::$NAME" | |
echo "::set-output name=changelog::$CHANGELOG" | |
echo "::set-output name=pluginVerifierHomeDir::~/.pluginVerifier" | |
./gradlew printProductsReleases # prepare list of IDEs for Plugin Verifier | |
# Run tests | |
- name: Run Tests | |
run: ./gradlew test | |
# Collect Tests Result of failed tests | |
- name: Collect Tests Result | |
if: ${{ failure() }} | |
uses: actions/[email protected] | |
with: | |
name: tests-result | |
path: ${{ github.workspace }}/build/reports/tests | |
# Free GitHub Actions Environment Disk Space | |
- name: Maximize Build Space | |
uses: jlumbroso/free-disk-space@main | |
with: | |
tool-cache: false | |
large-packages: false | |
# Cache Plugin Verifier IDEs | |
- name: Setup Plugin Verifier IDEs Cache | |
uses: actions/[email protected] | |
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 verifyPlugin -Pplugin.verifier.home.dir=${{ steps.properties.outputs.pluginVerifierHomeDir }} | |
# Collect Plugin Verifier Result | |
- name: Collect Plugin Verifier Result | |
if: ${{ always() }} | |
uses: actions/[email protected] | |
with: | |
name: pluginVerifier-result | |
path: ${{ github.workspace }}/build/reports/pluginVerifier | |
# Run Qodana inspections | |
# - name: Qodana - Code Inspection | |
# uses: JetBrains/[email protected] | |
# 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 "::set-output name=filename::${FILENAME:0:-4}" | |
- name: Display structure of distributions folder | |
run: ls -R | |
working-directory: ${{ github.workspace }}/build/distributions | |
# Store already-built plugin as an artifact for downloading | |
- name: Upload artifact | |
uses: actions/[email protected] | |
with: | |
name: ${{ steps.artifact.outputs.filename }}.zip | |
path: ./build/distributions/ | |
# 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 | |
steps: | |
# Check out current repository | |
- name: Fetch Sources | |
uses: actions/[email protected] | |
# Remove old release drafts by using the curl request for the available releases with 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/{} | |
- name: Download build-output artifact | |
uses: actions/download-artifact@v4 | |
with: | |
name: ${{ needs.build.outputs.filename }}.zip | |
path: ${{ github.workspace }}/build/distributions/ | |
- name: Display structure of downloaded files | |
run: ls -R | |
working-directory: ${{ github.workspace }}/build/distributions/ | |
# Create 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 | |
)" \ | |
${{ github.workspace }}/build/distributions/${{ needs.build.outputs.filename }}.zip |