Update build system to IntelliJ Platform Gradle Plugin 2.x #79

Workflow file for this run

	# 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 '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 'master' 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.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: 17

	# 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
	shell: bash
	run: \|
	PROPERTIES="$(./gradlew properties --console=plain -q)"
	VERSION="$(echo "$PROPERTIES" \| grep "^version:" \| cut -f2- -d ' ')"
	CHANGELOG="$(./gradlew getChangelog --unreleased --no-header --console=plain -q)"

	echo "version=$VERSION" >> $GITHUB_OUTPUT
	echo "pluginVerifierHomeDir=~/.pluginVerifier" >> $GITHUB_OUTPUT

	echo "changelog<<EOF" >> $GITHUB_OUTPUT
	echo "$CHANGELOG" >> $GITHUB_OUTPUT
	echo "EOF" >> $GITHUB_OUTPUT

	# 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: 17

	# 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-result
	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

	# Run Qodana inspections and provide report
	inspectCode:
	name: Inspect code
	needs: [ build ]
	runs-on: ubuntu-latest
	permissions:
	contents: write
	checks: write
	pull-requests: write
	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: 17

	# Run Qodana inspections
	- name: Qodana - Code Inspection
	uses: JetBrains/[email protected]
	with:
	cache-default-branch-only: true

	# 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: 17

	# 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
	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

	# 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, inspectCode, 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 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
	)"

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update build system to IntelliJ Platform Gradle Plugin 2.x #79

Workflow file

Update build system to IntelliJ Platform Gradle Plugin 2.x #79

Jobs

Run details

Workflow file for this run