ci(build): add step to maximize build space #242

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 Qodana inspections.
	# - Run the 'buildPlugin' task and prepare artifact for further tests.
	# - Run the 'runPluginVerifier' task.
	# - Create a draft release.
	#
	# The 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
	- support/*
	- release/*
	# Trigger the workflow on any pull request
	pull_request:
	types: [ opened, reopened ]
	# Trigger the workflow on manual dispatch
	workflow_dispatch:

	concurrency:
	group: ${{ github.workflow }}-${{ github.event.pull_request.number \|\| github.ref }}
	cancel-in-progress: true

	jobs:
	guard:
	name: Usage guard
	runs-on: ubuntu-latest
	steps:
	# Uses the action-usage-guard action
	- name: Run Action Usage Guard
	uses: nekofar/action-usage-guard@develop
	with:
	# GitHub access token for authentication.
	token: ${{ secrets.ACCESS_TOKEN }}
	# Defines the threshold for the usage guard.
	threshold: 70

	# Prepare environment and build the plugin
	build:
	name: Build
	runs-on: ubuntu-latest
	needs: [ guard ]
	outputs:
	version: ${{ steps.properties.outputs.version }}
	changelog: ${{ steps.changelog.outputs.changelog }}
	pluginVerifierHomeDir: ${{ steps.properties.outputs.pluginVerifierHomeDir }}
	steps:

	# Check out the current repository
	- name: Fetch Sources
	uses: actions/[email protected]

	# Validate wrapper
	- name: Gradle Wrapper Validation
	uses: gradle/actions/[email protected]

	# Set up Java environment for the next steps
	- name: Setup Java
	uses: actions/[email protected]
	with:
	distribution: zulu
	java-version: 17

	# Setup Gradle
	- name: Setup Gradle
	uses: gradle/actions/[email protected]
	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 ' ')"
	NAME="$(echo "$PROPERTIES" \| grep "^pluginName:" \| cut -f2- -d ' ')"

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

	# Extract changelog information
	- name: Prepare Changelog
	id: changelog
	shell: bash
	run: \|
	GRADLE_PARAMS=(--no-header --console=plain --quiet)
	if [[ $GITHUB_REF == refs/heads/release/* \|\| $GITHUB_REF == refs/pull/* ]]; then
	GRADLE_PARAMS+=(--unreleased)
	fi

	CHANGELOG="$(./gradlew getChangelog ${GRADLE_PARAMS[@]})"
	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/[email protected]
	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/[email protected]

	# Set up Java environment for the next steps
	- name: Setup Java
	uses: actions/[email protected]
	with:
	distribution: zulu
	java-version: 17

	# Setup Gradle
	- name: Setup Gradle
	uses: gradle/actions/[email protected]
	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/[email protected]
	with:
	name: tests-result
	path: ${{ github.workspace }}/build/reports/tests

	# Upload the Kover report to CodeCov
	- name: Upload Code Coverage Report
	uses: codecov/[email protected]
	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/[email protected]
	with:
	tool-cache: false
	large-packages: false

	# Check out the current repository
	- name: Fetch Sources
	uses: actions/[email protected]
	with:
	ref: ${{ github.event.pull_request.head.sha }} # to check out the actual pull request commit, not the merge commit
	fetch-depth: 0 # a full history is required for pull request analysis

	# Set up Java environment for the next steps
	- name: Setup Java
	uses: actions/[email protected]
	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/[email protected]
	with:
	tool-cache: false
	large-packages: false

	# 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/[email protected]

	# Set up Java environment for the next steps
	- name: Setup Java
	uses: actions/[email protected]
	with:
	distribution: zulu
	java-version: 17

	# Setup Gradle
	- name: Setup Gradle
	uses: gradle/actions/[email protected]

	# Cache Plugin Verifier IDEs
	- name: Setup Plugin Verifier IDEs Cache
	uses: actions/[email protected]
	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/[email protected]
	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.ref == 'refs/heads/master' \|\| startsWith(github.ref, 'refs/heads/support/')
	needs: [ build, test, inspectCode, verify ]
	runs-on: ubuntu-latest
	permissions:
	contents: write
	steps:

	# Check out the current repository
	- name: Fetch Sources
	uses: actions/[email protected]

	# Set up Java environment for the next steps
	- name: Setup Java
	uses: actions/[email protected]
	with:
	distribution: zulu
	java-version: 17

	# 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
	uses: nekofar/[email protected]
	with:
	tag: v${{ needs.build.outputs.version }} # The name of the tag to be released
	title: v${{ needs.build.outputs.version }} # The title for the release
	notes: ${{ needs.build.outputs.changelog }} # The release notes generated in the previous step
	draft: true # The release will be created as a draft
	prerelease: ${{ contains(needs.build.outputs.version, '-rc') \|\| contains(needs.build.outputs.version, '-beta') \|\| contains(needs.build.outputs.version, '-alpha') }} # Conditions to mark the release as a pre-release

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci(build): add step to maximize build space #242

Workflow file

ci(build): add step to maximize build space #242

Jobs

Run details

Workflow file for this run