JetBrains_intellij-platform.../.github/workflows/build.yml

256 lines
8.7 KiB
YAML
Raw Normal View History

# 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
2020-06-24 13:04:54 +00:00
#
## JBIJPPTPL
name: Build
on:
2021-05-31 10:15:43 +00:00
# Trigger the workflow on pushes to only the 'main' branch (this avoids duplicate checks being run e.g. for dependabot pull requests)
push:
2021-05-31 10:15:43 +00:00
branches: [main]
# Trigger the workflow on any pull request
pull_request:
2020-04-21 20:31:52 +00:00
jobs:
# Run Gradle Wrapper Validation Action to verify the wrapper's checksum
gradleValidation:
name: Gradle Wrapper
runs-on: ubuntu-latest
steps:
2020-06-17 05:19:59 +00:00
# Check out current repository
- name: Fetch Sources
uses: actions/checkout@v2.3.4
2020-06-17 05:19:59 +00:00
# Validate wrapper
- name: Gradle Wrapper Validation
uses: gradle/wrapper-validation-action@v1.0.4
2020-06-19 07:51:04 +00:00
# Run verifyPlugin and test Gradle tasks
2020-04-21 20:31:52 +00:00
test:
name: Test
needs: gradleValidation
2020-04-21 20:31:52 +00:00
runs-on: ubuntu-latest
steps:
2020-06-17 05:19:59 +00:00
2021-07-22 09:29:09 +00:00
# Setup Java 11 environment for the next steps
- name: Setup Java
uses: actions/setup-java@v2
with:
distribution: zulu
2021-07-22 09:29:09 +00:00
java-version: 11
# Check out current repository
2020-04-21 20:31:52 +00:00
- name: Fetch Sources
uses: actions/checkout@v2.3.4
2020-06-17 05:19:59 +00:00
# Cache Gradle dependencies
- name: Setup Gradle Dependencies Cache
uses: actions/cache@v2.1.6
2020-04-21 20:31:52 +00:00
with:
path: ~/.gradle/caches
key: ${{ runner.os }}-gradle-caches-${{ hashFiles('**/*.gradle', '**/*.gradle.kts', 'gradle.properties') }}
# Cache Gradle Wrapper
- name: Setup Gradle Wrapper Cache
uses: actions/cache@v2.1.6
with:
path: ~/.gradle/wrapper
key: ${{ runner.os }}-gradle-wrapper-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }}
2020-06-17 05:19:59 +00:00
2021-07-23 19:27:22 +00:00
# Run tests
- name: Run Tests
run: ./gradlew test
2020-06-17 05:19:59 +00:00
# Run verifyPlugin Gradle task
2020-04-21 20:31:52 +00:00
- name: Verify Plugin
2020-06-17 05:19:59 +00:00
run: ./gradlew verifyPlugin
2020-06-19 07:51:04 +00:00
# Build plugin with buildPlugin Gradle task and provide the artifact for the next workflow jobs
# Requires test job to be passed
2020-04-21 20:31:52 +00:00
build:
name: Build
needs: test
runs-on: ubuntu-latest
outputs:
name: ${{ steps.properties.outputs.name }}
version: ${{ steps.properties.outputs.version }}
changelog: ${{ steps.properties.outputs.changelog }}
artifact: ${{ steps.properties.outputs.artifact }}
2020-04-21 20:31:52 +00:00
steps:
2021-07-22 09:29:09 +00:00
# Setup Java 11 environment for the next steps
- name: Setup Java
uses: actions/setup-java@v2
with:
distribution: zulu
2021-07-22 09:29:09 +00:00
java-version: 11
2020-06-17 05:19:59 +00:00
# Check out current repository
2020-04-21 20:31:52 +00:00
- name: Fetch Sources
uses: actions/checkout@v2.3.4
2020-06-17 05:19:59 +00:00
# Cache Gradle Dependencies
- name: Setup Gradle Dependencies Cache
uses: actions/cache@v2.1.6
with:
path: ~/.gradle/caches
key: ${{ runner.os }}-gradle-caches-${{ hashFiles('**/*.gradle', '**/*.gradle.kts', 'gradle.properties') }}
# Cache Gradle Wrapper
- name: Setup Gradle Wrapper Cache
uses: actions/cache@v2.1.6
2020-04-21 20:31:52 +00:00
with:
path: ~/.gradle/wrapper
key: ${{ runner.os }}-gradle-wrapper-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }}
2020-06-17 05:19:59 +00:00
# Set environment variables
2020-04-21 20:31:52 +00:00
- name: Export Properties
id: properties
shell: bash
2020-04-21 20:31:52 +00:00
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)"
CHANGELOG="${CHANGELOG//'%'/'%25'}"
CHANGELOG="${CHANGELOG//$'\n'/'%0A'}"
CHANGELOG="${CHANGELOG//$'\r'/'%0D'}"
ARTIFACT="${NAME}-${VERSION}.zip"
echo "::set-output name=version::$VERSION"
echo "::set-output name=name::$NAME"
echo "::set-output name=changelog::$CHANGELOG"
echo "::set-output name=artifact::$ARTIFACT"
2020-06-17 05:19:59 +00:00
# Build artifact using buildPlugin Gradle task
2020-04-21 20:31:52 +00:00
- name: Build Plugin
2020-06-17 05:19:59 +00:00
run: ./gradlew buildPlugin
# Upload plugin artifact to make it available in the next jobs
2020-04-21 20:31:52 +00:00
- name: Upload artifact
uses: actions/upload-artifact@v2.2.4
2020-04-21 20:31:52 +00:00
with:
name: plugin-artifact
path: ./build/distributions/${{ steps.properties.outputs.artifact }}
2020-06-19 07:51:04 +00:00
# Verify built plugin using IntelliJ Plugin Verifier tool
# Requires build job to be passed
2020-04-21 20:31:52 +00:00
verify:
name: Verify
needs: build
runs-on: ubuntu-latest
steps:
2020-06-17 05:19:59 +00:00
2021-07-22 09:29:09 +00:00
# Setup Java 11 environment for the next steps
- name: Setup Java
uses: actions/setup-java@v2
2020-04-21 20:31:52 +00:00
with:
distribution: zulu
2021-07-22 09:29:09 +00:00
java-version: 11
# Check out current repository
- name: Fetch Sources
uses: actions/checkout@v2.3.4
# Cache Gradle Dependencies
- name: Setup Gradle Dependencies Cache
uses: actions/cache@v2.1.6
with:
path: ~/.gradle/caches
key: ${{ runner.os }}-gradle-caches-${{ hashFiles('**/*.gradle', '**/*.gradle.kts', 'gradle.properties') }}
# Cache Gradle Wrapper
- name: Setup Gradle Wrapper Cache
uses: actions/cache@v2.1.6
with:
path: ~/.gradle/wrapper
key: ${{ runner.os }}-gradle-wrapper-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }}
2020-06-17 05:19:59 +00:00
# Set environment variables
- name: Export Properties
id: properties
shell: bash
run: |
PROPERTIES="$(./gradlew properties --console=plain -q)"
IDE_VERSIONS="$(echo "$PROPERTIES" | grep "^pluginVerifierIdeVersions:" | base64)"
echo "::set-output name=ideVersions::$IDE_VERSIONS"
echo "::set-output name=pluginVerifierHomeDir::~/.pluginVerifier"
# Cache Plugin Verifier IDEs
- name: Setup Plugin Verifier IDEs Cache
uses: actions/cache@v2.1.6
with:
path: ${{ steps.properties.outputs.pluginVerifierHomeDir }}/ides
key: ${{ runner.os }}-plugin-verifier-${{ steps.properties.outputs.ideVersions }}
# Run IntelliJ Plugin Verifier action using GitHub Action
2020-04-21 20:31:52 +00:00
- name: Verify Plugin
run: ./gradlew runPluginVerifier -Pplugin.verifier.home.dir=${{ steps.properties.outputs.pluginVerifierHomeDir }}
2020-06-19 07:51:04 +00:00
# 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, verify]
runs-on: ubuntu-latest
steps:
2020-06-17 05:19:59 +00:00
# Check out current repository
- name: Fetch Sources
uses: actions/checkout@v2.3.4
2020-06-17 05:19:59 +00:00
# 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: |
curl -H "Authorization: Bearer $GITHUB_TOKEN" https://api.github.com/repos/$GITHUB_REPOSITORY/releases \
| tr '\r\n' ' ' \
| jq '.[] | select(.draft == true) | .id' \
| xargs -I '{}' \
curl -X DELETE -H "Authorization: Bearer $GITHUB_TOKEN" https://api.github.com/repos/$GITHUB_REPOSITORY/releases/{}
2020-06-17 05:19:59 +00:00
# Create new release draft - which is not publicly visible and requires manual acceptance
- name: Create Release Draft
id: createDraft
uses: actions/create-release@v1.1.4
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: v${{ needs.build.outputs.version }}
release_name: v${{ needs.build.outputs.version }}
body: ${{ needs.build.outputs.changelog }}
draft: true
2020-06-17 05:19:59 +00:00
# Download plugin artifact provided by the previous job
- name: Download Artifact
uses: actions/download-artifact@v2
with:
name: plugin-artifact
2020-06-17 05:19:59 +00:00
# Upload artifact as a release asset
- name: Upload Release Asset
id: upload-release-asset
uses: actions/upload-release-asset@v1.0.2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.createDraft.outputs.upload_url }}
asset_path: ./${{ needs.build.outputs.artifact }}
asset_name: ${{ needs.build.outputs.artifact }}
asset_content_type: application/zip