-
-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
timo
committed
Jan 30, 2022
0 parents
commit d8e632f
Showing
37 changed files
with
5,713 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
--- | ||
|
||
<!-- Please do not use this issue tracker for support or questions, use Forum or Slack listed here: | ||
https://plugins.jetbrains.com/docs/intellij/getting-help.html | ||
Please **always** provide link to sources if possible. --> | ||
|
||
**Describe the bug:** | ||
<!-- A clear and concise description of what the bug is. --> | ||
|
||
**Steps to reproduce:** | ||
<!-- Steps to reproduce the issue. --> | ||
|
||
**Expected behavior:** | ||
<!-- A clear and concise description of what you expected to happen. --> | ||
|
||
**Additional context:** | ||
<!-- Add any other context about the problem here. --> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Dependabot configuration: | ||
# https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates | ||
|
||
version: 2 | ||
updates: | ||
# Maintain dependencies for Gradle dependencies | ||
- package-ecosystem: "gradle" | ||
directory: "/" | ||
target-branch: "next" | ||
schedule: | ||
interval: "daily" | ||
# Maintain dependencies for GitHub Actions | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
target-branch: "next" | ||
schedule: | ||
interval: "daily" |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Dependabot configuration: | ||
# https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates | ||
|
||
version: 2 | ||
updates: | ||
# Maintain dependencies for Gradle dependencies | ||
- package-ecosystem: "gradle" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" | ||
# Maintain dependencies for GitHub Actions | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<!-- Keep a Changelog guide -> https://keepachangelog.com --> | ||
|
||
# %NAME% Changelog | ||
|
||
## [Unreleased] | ||
### Added | ||
- Initial scaffold created from [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# %NAME% | ||
|
||
![Build](https://github.com/%REPOSITORY%/workflows/Build/badge.svg) | ||
[![Version](https://img.shields.io/jetbrains/plugin/v/PLUGIN_ID.svg)](https://plugins.jetbrains.com/plugin/PLUGIN_ID) | ||
[![Downloads](https://img.shields.io/jetbrains/plugin/d/PLUGIN_ID.svg)](https://plugins.jetbrains.com/plugin/PLUGIN_ID) | ||
|
||
## Template ToDo list | ||
- [x] Create a new [IntelliJ Platform Plugin Template][template] project. | ||
- [ ] Get familiar with the [template documentation][template]. | ||
- [ ] Verify the [pluginGroup](/gradle.properties), [plugin ID](/src/main/resources/META-INF/plugin.xml) and [sources package](/src/main/kotlin). | ||
- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html). | ||
- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time. | ||
- [ ] Set the Plugin ID in the above README badges. | ||
- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html). | ||
- [ ] Click the <kbd>Watch</kbd> button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes. | ||
|
||
<!-- Plugin description --> | ||
This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have. | ||
|
||
This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process. | ||
|
||
To keep everything working, do not remove `<!-- ... -->` sections. | ||
<!-- Plugin description end --> | ||
|
||
## Installation | ||
|
||
- Using IDE built-in plugin system: | ||
|
||
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "%NAME%"</kbd> > | ||
<kbd>Install Plugin</kbd> | ||
|
||
- Manually: | ||
|
||
Download the [latest release](https://github.com/%REPOSITORY%/releases/latest) and install it manually using | ||
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd> | ||
|
||
|
||
--- | ||
Plugin based on the [IntelliJ Platform Plugin Template][template]. | ||
|
||
[template]: https://github.com/JetBrains/intellij-platform-plugin-template |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# IntelliJ Platform Artifacts Repositories | ||
# -> https://plugins.jetbrains.com/docs/intellij/intellij-artifacts.html | ||
|
||
pluginGroup = %GROUP% | ||
pluginName = %NAME% | ||
# SemVer format -> https://semver.org | ||
pluginVersion = 0.0.1 | ||
|
||
# See https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html | ||
# for insight into build numbers and IntelliJ Platform versions. | ||
pluginSinceBuild = 203 | ||
pluginUntilBuild = 213.* | ||
|
||
# IntelliJ Platform Properties -> https://github.com/JetBrains/gradle-intellij-plugin#intellij-platform-properties | ||
platformType = IC | ||
platformVersion = 2020.3.4 | ||
|
||
# Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html | ||
# Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22 | ||
platformPlugins = | ||
|
||
# Java language level used to compile sources and to generate the files for - Java 11 is required since 2020.3 | ||
javaVersion = 11 | ||
|
||
# Gradle Releases -> https://github.com/gradle/gradle/releases | ||
gradleVersion = 7.3.3 | ||
|
||
# Opt-out flag for bundling Kotlin standard library. | ||
# See https://plugins.jetbrains.com/docs/intellij/kotlin.html#kotlin-standard-library for details. | ||
# suppress inspection "UnusedProperty" | ||
kotlin.stdlib.default.dependency = false |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
rootProject.name = "%NAME%" |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,158 @@ | ||
# 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: | ||
|
||
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 }} | ||
steps: | ||
|
||
# Check out current repository | ||
- name: Fetch Sources | ||
uses: actions/[email protected] | ||
|
||
# Validate wrapper | ||
- name: Gradle Wrapper Validation | ||
uses: gradle/[email protected] | ||
|
||
# Setup Java 11 environment for the next steps | ||
- name: Setup Java | ||
uses: actions/setup-java@v2 | ||
with: | ||
distribution: zulu | ||
java-version: 11 | ||
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)" | ||
CHANGELOG="${CHANGELOG//'%'/'%25'}" | ||
CHANGELOG="${CHANGELOG//$'\n'/'%0A'}" | ||
CHANGELOG="${CHANGELOG//$'\r'/'%0D'}" | ||
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 listProductsReleases # 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/upload-artifact@v2 | ||
with: | ||
name: tests-result | ||
path: ${{ github.workspace }}/build/reports/tests | ||
|
||
# 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 runPluginVerifier -Pplugin.verifier.home.dir=${{ steps.properties.outputs.pluginVerifierHomeDir }} | ||
|
||
# Collect Plugin Verifier Result | ||
- name: Collect Plugin Verifier Result | ||
if: ${{ always() }} | ||
uses: actions/upload-artifact@v2 | ||
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}" | ||
# 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/*/* | ||
|
||
# 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/{} | ||
# 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 | ||
)" |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
# GitHub Actions Workflow created for handling the release process based on the draft release prepared | ||
# with the Build workflow. Running the publishPlugin task requires the PUBLISH_TOKEN secret provided. | ||
|
||
name: Release | ||
on: | ||
release: | ||
types: [prereleased, released] | ||
|
||
jobs: | ||
|
||
# Prepare and publish the plugin to the Marketplace repository | ||
release: | ||
name: Publish Plugin | ||
runs-on: ubuntu-latest | ||
steps: | ||
|
||
# Check out current repository | ||
- name: Fetch Sources | ||
uses: actions/[email protected] | ||
with: | ||
ref: ${{ github.event.release.tag_name }} | ||
|
||
# Setup Java 11 environment for the next steps | ||
- name: Setup Java | ||
uses: actions/setup-java@v2 | ||
with: | ||
distribution: zulu | ||
java-version: 11 | ||
cache: gradle | ||
|
||
# Set environment variables | ||
- name: Export Properties | ||
id: properties | ||
shell: bash | ||
run: | | ||
CHANGELOG="$(cat << 'EOM' | sed -e 's/^[[:space:]]*$//g' -e '/./,$!d' | ||
${{ github.event.release.body }} | ||
EOM | ||
)" | ||
CHANGELOG="${CHANGELOG//'%'/'%25'}" | ||
CHANGELOG="${CHANGELOG//$'\n'/'%0A'}" | ||
CHANGELOG="${CHANGELOG//$'\r'/'%0D'}" | ||
echo "::set-output name=changelog::$CHANGELOG" | ||
# Update Unreleased section with the current release note | ||
- name: Patch Changelog | ||
if: ${{ steps.properties.outputs.changelog != '' }} | ||
env: | ||
CHANGELOG: ${{ steps.properties.outputs.changelog }} | ||
run: | | ||
./gradlew patchChangelog --release-note="$CHANGELOG" | ||
# Publish the plugin to the Marketplace | ||
- name: Publish Plugin | ||
env: | ||
PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }} | ||
run: ./gradlew publishPlugin | ||
|
||
# Upload artifact as a release asset | ||
- name: Upload Release Asset | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
run: gh release upload ${{ github.event.release.tag_name }} ./build/distributions/* | ||
|
||
# Create pull request | ||
- name: Create Pull Request | ||
if: ${{ steps.properties.outputs.changelog != '' }} | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
run: | | ||
VERSION="${{ github.event.release.tag_name }}" | ||
BRANCH="changelog-update-$VERSION" | ||
git config user.email "[email protected]" | ||
git config user.name "GitHub Action" | ||
git checkout -b $BRANCH | ||
git commit -am "Changelog update - $VERSION" | ||
git push --set-upstream origin $BRANCH | ||
gh pr create \ | ||
--title "Changelog update - \`$VERSION\`" \ | ||
--body "Current pull request contains patched \`CHANGELOG.md\` file for the \`$VERSION\` version." \ | ||
--base main \ | ||
--head $BRANCH |
Oops, something went wrong.