mirror of
https://github.com/JetBrains/intellij-platform-plugin-template.git
synced 2025-12-05 06:11:52 +00:00
Fix CHANGELOG.md comparison links and missing "v" prefix for some GitHub release tags
- Adds "v" to the tag name when creating the draft release - Adds `sectionUrlBuilder` to handle exiting tags without the "v" prefix - Adds a template `build.gradle.kts` to without the repo specific tag fixes
This commit is contained in:
parent
de6b4c8a9d
commit
f3481de7a0
159
.github/template-cleanup/build.gradle.kts
vendored
Normal file
159
.github/template-cleanup/build.gradle.kts
vendored
Normal file
@ -0,0 +1,159 @@
|
|||||||
|
import org.jetbrains.changelog.Changelog
|
||||||
|
import org.jetbrains.changelog.ChangelogSectionUrlBuilder
|
||||||
|
import org.jetbrains.changelog.markdownToHTML
|
||||||
|
import org.jetbrains.intellij.platform.gradle.TestFrameworkType
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
id("java") // Java support
|
||||||
|
alias(libs.plugins.kotlin) // Kotlin support
|
||||||
|
alias(libs.plugins.intelliJPlatform) // IntelliJ Platform Gradle Plugin
|
||||||
|
alias(libs.plugins.changelog) // Gradle Changelog Plugin
|
||||||
|
alias(libs.plugins.qodana) // Gradle Qodana Plugin
|
||||||
|
alias(libs.plugins.kover) // Gradle Kover Plugin
|
||||||
|
}
|
||||||
|
|
||||||
|
group = providers.gradleProperty("pluginGroup").get()
|
||||||
|
version = providers.gradleProperty("pluginVersion").get()
|
||||||
|
|
||||||
|
// Set the JVM language level used to build the project.
|
||||||
|
kotlin {
|
||||||
|
jvmToolchain(21)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Configure project's dependencies
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
|
||||||
|
// IntelliJ Platform Gradle Plugin Repositories Extension - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-repositories-extension.html
|
||||||
|
intellijPlatform {
|
||||||
|
defaultRepositories()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dependencies are managed with Gradle version catalog - read more: https://docs.gradle.org/current/userguide/version_catalogs.html
|
||||||
|
dependencies {
|
||||||
|
testImplementation(libs.junit)
|
||||||
|
testImplementation(libs.opentest4j)
|
||||||
|
|
||||||
|
// IntelliJ Platform Gradle Plugin Dependencies Extension - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html
|
||||||
|
intellijPlatform {
|
||||||
|
intellijIdea(providers.gradleProperty("platformVersion"))
|
||||||
|
|
||||||
|
// Plugin Dependencies. Uses `platformBundledPlugins` property from the gradle.properties file for bundled IntelliJ Platform plugins.
|
||||||
|
bundledPlugins(providers.gradleProperty("platformBundledPlugins").map { it.split(',') })
|
||||||
|
|
||||||
|
// Plugin Dependencies. Uses `platformPlugins` property from the gradle.properties file for plugin from JetBrains Marketplace.
|
||||||
|
plugins(providers.gradleProperty("platformPlugins").map { it.split(',') })
|
||||||
|
|
||||||
|
// Module Dependencies. Uses `platformBundledModules` property from the gradle.properties file for bundled IntelliJ Platform modules.
|
||||||
|
bundledModules(providers.gradleProperty("platformBundledModules").map { it.split(',') })
|
||||||
|
|
||||||
|
testFramework(TestFrameworkType.Platform)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Configure IntelliJ Platform Gradle Plugin - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-extension.html
|
||||||
|
intellijPlatform {
|
||||||
|
pluginConfiguration {
|
||||||
|
name = providers.gradleProperty("pluginName")
|
||||||
|
version = providers.gradleProperty("pluginVersion")
|
||||||
|
|
||||||
|
// Extract the <!-- Plugin description --> section from README.md and provide for the plugin's manifest
|
||||||
|
description = providers.fileContents(layout.projectDirectory.file("README.md")).asText.map {
|
||||||
|
val start = "<!-- Plugin description -->"
|
||||||
|
val end = "<!-- Plugin description end -->"
|
||||||
|
|
||||||
|
with(it.lines()) {
|
||||||
|
if (!containsAll(listOf(start, end))) {
|
||||||
|
throw GradleException("Plugin description section not found in README.md:\n$start ... $end")
|
||||||
|
}
|
||||||
|
subList(indexOf(start) + 1, indexOf(end)).joinToString("\n").let(::markdownToHTML)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
val changelog = project.changelog // local variable for configuration cache compatibility
|
||||||
|
// Get the latest available change notes from the changelog file
|
||||||
|
changeNotes = providers.gradleProperty("pluginVersion").map { pluginVersion ->
|
||||||
|
with(changelog) {
|
||||||
|
renderItem(
|
||||||
|
(getOrNull(pluginVersion) ?: getUnreleased())
|
||||||
|
.withHeader(false)
|
||||||
|
.withEmptySections(false),
|
||||||
|
Changelog.OutputType.HTML,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ideaVersion {
|
||||||
|
sinceBuild = providers.gradleProperty("pluginSinceBuild")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
signing {
|
||||||
|
certificateChain = providers.environmentVariable("CERTIFICATE_CHAIN")
|
||||||
|
privateKey = providers.environmentVariable("PRIVATE_KEY")
|
||||||
|
password = providers.environmentVariable("PRIVATE_KEY_PASSWORD")
|
||||||
|
}
|
||||||
|
|
||||||
|
publishing {
|
||||||
|
token = providers.environmentVariable("PUBLISH_TOKEN")
|
||||||
|
// 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/publishing-plugin.html#specifying-a-release-channel
|
||||||
|
channels = providers.gradleProperty("pluginVersion").map { listOf(it.substringAfter('-', "").substringBefore('.').ifEmpty { "default" }) }
|
||||||
|
}
|
||||||
|
|
||||||
|
pluginVerification {
|
||||||
|
ides {
|
||||||
|
recommended()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Configure Gradle Changelog Plugin - read more: https://github.com/JetBrains/gradle-changelog-plugin
|
||||||
|
changelog {
|
||||||
|
groups.empty()
|
||||||
|
repositoryUrl = providers.gradleProperty("pluginRepositoryUrl")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Configure Gradle Kover Plugin - read more: https://kotlin.github.io/kotlinx-kover/gradle-plugin/#configuration-details
|
||||||
|
kover {
|
||||||
|
reports {
|
||||||
|
total {
|
||||||
|
xml {
|
||||||
|
onCheck = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
tasks {
|
||||||
|
wrapper {
|
||||||
|
gradleVersion = providers.gradleProperty("gradleVersion").get()
|
||||||
|
}
|
||||||
|
|
||||||
|
publishPlugin {
|
||||||
|
dependsOn(patchChangelog)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
intellijPlatformTesting {
|
||||||
|
runIde {
|
||||||
|
register("runIdeForUiTests") {
|
||||||
|
task {
|
||||||
|
jvmArgumentProviders += CommandLineArgumentProvider {
|
||||||
|
listOf(
|
||||||
|
"-Drobot-server.port=8082",
|
||||||
|
"-Dide.mac.message.dialogs.as.sheets=false",
|
||||||
|
"-Djb.privacy.policy.text=<!--999.999-->",
|
||||||
|
"-Djb.consents.confirmation.enabled=false",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
robotServerPlugin()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
2
.github/workflows/build.yml
vendored
2
.github/workflows/build.yml
vendored
@ -240,7 +240,7 @@ jobs:
|
|||||||
RELEASE_NOTE="./build/tmp/release_note.txt"
|
RELEASE_NOTE="./build/tmp/release_note.txt"
|
||||||
./gradlew getChangelog --unreleased --no-header --quiet --console=plain --output-file=$RELEASE_NOTE
|
./gradlew getChangelog --unreleased --no-header --quiet --console=plain --output-file=$RELEASE_NOTE
|
||||||
|
|
||||||
gh release create $VERSION \
|
gh release create v$VERSION \
|
||||||
--draft \
|
--draft \
|
||||||
--title $VERSION \
|
--title $VERSION \
|
||||||
--notes-file $RELEASE_NOTE
|
--notes-file $RELEASE_NOTE
|
||||||
|
|||||||
@ -4,6 +4,15 @@
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- GitHub Actions: template `build.gradle.kts` without the Changelog `sectionUrlBuilder` for tag prefix handling
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- GitHub Actions - release tag version missing "v" prefix when created
|
||||||
|
- Gradle - comparison links in CHANGELOG.md using "v" prefix for tags that don't have it
|
||||||
|
|
||||||
## [2.4.0] - 2025-11-25
|
## [2.4.0] - 2025-11-25
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|||||||
@ -1,4 +1,5 @@
|
|||||||
import org.jetbrains.changelog.Changelog
|
import org.jetbrains.changelog.Changelog
|
||||||
|
import org.jetbrains.changelog.ChangelogSectionUrlBuilder
|
||||||
import org.jetbrains.changelog.markdownToHTML
|
import org.jetbrains.changelog.markdownToHTML
|
||||||
import org.jetbrains.intellij.platform.gradle.TestFrameworkType
|
import org.jetbrains.intellij.platform.gradle.TestFrameworkType
|
||||||
|
|
||||||
@ -113,6 +114,27 @@ intellijPlatform {
|
|||||||
changelog {
|
changelog {
|
||||||
groups.empty()
|
groups.empty()
|
||||||
repositoryUrl = providers.gradleProperty("pluginRepositoryUrl")
|
repositoryUrl = providers.gradleProperty("pluginRepositoryUrl")
|
||||||
|
// Handle some of GitHub release tags missing the default "v" prefix
|
||||||
|
sectionUrlBuilder = ChangelogSectionUrlBuilder { repositoryUrl, currentVersion, previousVersion, isUnreleased ->
|
||||||
|
val prefix: (String?) -> String = { version -> when (version) {
|
||||||
|
"2.3.0" -> ""
|
||||||
|
"2.3.1" -> ""
|
||||||
|
"2.4.0" -> ""
|
||||||
|
else -> "v"
|
||||||
|
} }
|
||||||
|
val previousPrefix = prefix(previousVersion)
|
||||||
|
val currentPrefix = prefix(currentVersion)
|
||||||
|
repositoryUrl + when {
|
||||||
|
isUnreleased -> when (previousVersion) {
|
||||||
|
null -> "/commits"
|
||||||
|
else -> "/compare/$previousPrefix$previousVersion...HEAD"
|
||||||
|
}
|
||||||
|
|
||||||
|
previousVersion == null -> "/commits/$currentPrefix$currentVersion"
|
||||||
|
|
||||||
|
else -> "/compare/$previousPrefix$previousVersion...$currentPrefix$currentVersion"
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Configure Gradle Kover Plugin - read more: https://kotlin.github.io/kotlinx-kover/gradle-plugin/#configuration-details
|
// Configure Gradle Kover Plugin - read more: https://kotlin.github.io/kotlinx-kover/gradle-plugin/#configuration-details
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user