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

212 lines
6.8 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
2020-04-21 20:31:52 +00:00
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:
2020-06-17 05:19:59 +00:00
# Check out current repository
- name: Fetch Sources
uses: actions/checkout@v2
2020-06-17 05:19:59 +00:00
# Validate wrapper
- name: Gradle Wrapper Validation
uses: gradle/wrapper-validation-action@v1
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
# Check out current repository
2020-04-21 20:31:52 +00:00
- name: Fetch Sources
uses: actions/checkout@v2
2020-06-17 05:19:59 +00:00
# Setup Java 1.8 environment for the next steps
2020-04-21 20:31:52 +00:00
- name: Setup Java
uses: actions/setup-java@v1
with:
java-version: 1.8
2020-06-17 05:19:59 +00:00
# Cache Gradle dependencies
2020-04-21 20:31:52 +00:00
- name: Setup Cache
uses: actions/cache@v1
with:
path: ~/.gradle/caches
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
restore-keys: ${{ runner.os }}-gradle-
2020-06-17 05:19:59 +00:00
2020-05-05 19:56:33 +00:00
# Run detekt
- name: Run Linter
run: ./gradlew detekt
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
# Run test Gradle task
2020-04-21 20:31:52 +00:00
- name: Run Tests
2020-06-17 05:19:59 +00:00
run: ./gradlew test
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 }}
artifact: ${{ steps.properties.outputs.name }}-${{ steps.properties.outputs.version }}.zip
changelog: ${{ steps.properties.outputs.changelog }}
2020-04-21 20:31:52 +00:00
steps:
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
2020-06-17 05:19:59 +00:00
# Setup Java 1.8 environment for the next steps
2020-04-21 20:31:52 +00:00
- name: Setup Java
uses: actions/setup-java@v1
with:
java-version: 1.8
2020-06-17 05:19:59 +00:00
# Cache Gradle dependencies
2020-04-21 20:31:52 +00:00
- name: Setup Cache
uses: actions/cache@v1
with:
path: ~/.gradle/caches
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
restore-keys: ${{ runner.os }}-gradle-
2020-06-17 05:19:59 +00:00
# Set environment variables
2020-04-21 20:31:52 +00:00
- name: Export Properties
id: properties
2020-04-21 20:31:52 +00:00
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 ' ')"
2020-06-17 05:19:59 +00:00
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"
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@v1
with:
name: plugin-artifact
path: ./build/distributions/${{ needs.build.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
# Download plugin artifact provided by the previous job
- name: Download Artifact
2020-04-21 20:31:52 +00:00
uses: actions/download-artifact@v1
with:
name: plugin-artifact
2020-06-17 05:19:59 +00:00
# Run IntelliJ Plugin Verifier action using GitHub Action
2020-04-21 20:31:52 +00:00
- name: Verify Plugin
id: verify
uses: ChrisCarini/intellij-platform-plugin-verifier-action@v0.0.2
with:
plugin-location: plugin-artifact/${{ needs.build.outputs.artifact }}
2020-04-21 20:31:52 +00:00
ide-versions: |
ideaIC:2019.3
ideaIC:2020.1
2020-06-17 05:19:59 +00:00
# Print the output of the verify step
2020-04-21 20:31:52 +00:00
- name: Print Logs
env:
OUTPUT_LOG: ${{ steps.verify.outputs.verification-output-log-filename }}
2020-04-21 20:31:52 +00:00
run: |
echo "The verifier log file [$OUTPUT_LOG] contents : " ;
cat $OUTPUT_LOG
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.ref == 'refs/heads/master'
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
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
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@v1
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
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.createDraft.outputs.upload_url }}
asset_path: ./plugin-artifact/${{ needs.build.outputs.artifact }}
asset_name: ${{ needs.build.outputs.artifact }}
asset_content_type: application/zip