From b99218fb839a2b5fc859066642778736db67b814 Mon Sep 17 00:00:00 2001 From: Jakub Chrzanowski Date: Fri, 13 Jan 2023 21:34:46 +0100 Subject: [PATCH] Minor fixes reported by the code inspection --- .github/readme/intellij-platform-plugin-template-dark.svg | 2 +- .github/readme/intellij-platform-plugin-template-light.svg | 2 +- .github/template-cleanup/gradle.properties | 1 + .github/workflows/build.yml | 6 +++--- .github/workflows/release.yml | 7 +++---- .github/workflows/template-cleanup.yml | 2 +- build.gradle.kts | 4 ++-- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/readme/intellij-platform-plugin-template-dark.svg b/.github/readme/intellij-platform-plugin-template-dark.svg index 55cd0c0..e0bd869 100644 --- a/.github/readme/intellij-platform-plugin-template-dark.svg +++ b/.github/readme/intellij-platform-plugin-template-dark.svg @@ -1,4 +1,4 @@ - + diff --git a/.github/readme/intellij-platform-plugin-template-light.svg b/.github/readme/intellij-platform-plugin-template-light.svg index f372ae0..becd633 100644 --- a/.github/readme/intellij-platform-plugin-template-light.svg +++ b/.github/readme/intellij-platform-plugin-template-light.svg @@ -1,4 +1,4 @@ - + diff --git a/.github/template-cleanup/gradle.properties b/.github/template-cleanup/gradle.properties index 43645ae..08e2fd4 100644 --- a/.github/template-cleanup/gradle.properties +++ b/.github/template-cleanup/gradle.properties @@ -26,4 +26,5 @@ gradleVersion = 7.6 kotlin.stdlib.default.dependency = false # Enable Gradle Configuration Cache -> https://docs.gradle.org/current/userguide/configuration_cache.html +# suppress inspection "UnusedProperty" org.gradle.unsafe.configuration-cache = true diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6b20e4c..2ceb00b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,4 +1,4 @@ -# GitHub Actions Workflow created for testing and preparing the plugin release in following steps: +# 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, @@ -149,7 +149,7 @@ jobs: - name: Fetch Sources uses: actions/checkout@v3 - # Remove old release drafts by using the curl request for the available releases with draft flag + # 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 }} @@ -158,7 +158,7 @@ jobs: --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 + # Create a new release draft which is not publicly visible and requires manual acceptance - name: Create Release Draft env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f5dc532..3bb6732 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,7 +1,6 @@ -# GitHub Actions Workflow created for handling the release process based on the draft release prepared -# with the Build workflow. Running the publishPlugin task requires all of the following secrets to be be provided: -# PUBLISH_TOKEN, PRIVATE_KEY, PRIVATE_KEY_PASSWORD, CERTIFICATE_CHAIN -# See https://plugins.jetbrains.com/docs/intellij/plugin-signing.html for more information +# GitHub Actions Workflow created for handling the release process based on the draft release prepared with the Build workflow. +# Running the publishPlugin task requires all following secrets to be provided: PUBLISH_TOKEN, PRIVATE_KEY, PRIVATE_KEY_PASSWORD, CERTIFICATE_CHAIN. +# See https://plugins.jetbrains.com/docs/intellij/plugin-signing.html for more information. name: Release on: diff --git a/.github/workflows/template-cleanup.yml b/.github/workflows/template-cleanup.yml index 6e246d7..ede8fdf 100644 --- a/.github/workflows/template-cleanup.yml +++ b/.github/workflows/template-cleanup.yml @@ -9,7 +9,7 @@ on: jobs: - # Run cleaning process only if workflow is triggered by the non-"intellij-platform-plugin-template" repository. + # Run a cleaning process only if the workflow is triggered by the non-"intellij-platform-plugin-template" repository. template-cleanup: name: Template Cleanup runs-on: ubuntu-latest diff --git a/build.gradle.kts b/build.gradle.kts index 590a8d5..4710c22 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -26,7 +26,7 @@ repositories { mavenCentral() } -// Set the JVM language level used to build project. Use Java 11 for 2020.3+, and Java 17 for 2022.2+. +// Set the JVM language level used to build the project. Use Java 11 for 2020.3+, and Java 17 for 2022.2+. kotlin { jvmToolchain(11) } @@ -113,7 +113,7 @@ tasks { publishPlugin { dependsOn("patchChangelog") token.set(System.getenv("PUBLISH_TOKEN")) - // pluginVersion is based on the SemVer (https://semver.org) and supports pre-release labels, like 2.1.7-alpha.3 + // The pluginVersion is based on the SemVer (https://semver.org) and supports pre-release labels, like 2.1.7-alpha.3 // Specify pre-release label to publish the plugin in a custom Release Channel automatically. Read more: // https://plugins.jetbrains.com/docs/intellij/deployment.html#specifying-a-release-channel channels.set(listOf(properties("pluginVersion").split('-').getOrElse(1) { "default" }.split('.').first()))