Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://github.com/JetBrains/gradle-changelog-plugin below:

JetBrains/gradle-changelog-plugin: Plugin for parsing and managing the Changelog in a "keep a changelog" style.

A Gradle plugin providing tasks and helper methods to simplify working with a changelog that is managed in the keep a changelog style.

Note

This project requires Gradle 6.8 or newer

Upgrade Gradle Wrapper with ./gradlew wrapper --gradle-version 8.3

• Usage
• Configuration
• Tasks
  • getChangelog
  • initializeChangelog
  • patchChangelog
• Extension Methods
  • get
  • getUnreleased
  • getLatest
  • has
  • render
  • renderItem
  • getInstance
• Classes
  • Changelog
  • Changelog.OutputType
  • Changelog.Item
• Helper Methods
• Usage Examples
• Changelog
• Contributing
• License

The latest available version is:

Note

The patchPluginXml task is defined in Gradle IntelliJ Plugin

build.gradle.kts (Kotlin)

import org.jetbrains.changelog.Changelog
import org.jetbrains.changelog.ChangelogSectionUrlBuilder
import org.jetbrains.changelog.date

plugins {
    id("org.jetbrains.changelog") version "..."
}

tasks {
    // ...

    patchPluginXml {
        changeNotes = provider {
            changelog.renderItem(
                changelog
                    .getUnreleased()
                    .withHeader(false)
                    .withEmptySections(false),
                Changelog.OutputType.HTML
            )
        }
    }
}

changelog {
    version = "1.0.0"
    path = file("CHANGELOG.md").canonicalPath
    header = provider { "[${version.get()}] - ${date()}" }
    headerParserRegex = """(\d+\.\d+)""".toRegex()
    introduction =
        """
        My awesome project that provides a lot of useful features, like:
        
        - Feature 1
        - Feature 2
        - and Feature 3
        """.trimIndent()
    itemPrefix = "-"
    keepUnreleasedSection = true
    unreleasedTerm = "[Unreleased]"
    groups = listOf("Added", "Changed", "Deprecated", "Removed", "Fixed", "Security")
    lineSeparator = "\n"
    combinePreReleases = true
    sectionUrlBuilder = ChangelogSectionUrlBuilder { repositoryUrl, currentVersion, previousVersion, isUnreleased -> "foo" }
    outputFile = file("release-note.txt")
}

build.gradle (Groovy)

import org.jetbrains.changelog.Changelog
import org.jetbrains.changelog.ChangelogSectionUrlBuilder
import org.jetbrains.changelog.ExtensionsKt

plugins {
    id 'org.jetbrains.changelog' version '...'
}

apply plugin: 'org.jetbrains.changelog'

intellij {
    // ...

    patchPluginXml {
        changeNotes = provider {
            changelog.renderItem(
                changelog
                    .getUnreleased()
                    .withHeader(false)
                    .withEmptySections(false),
                Changelog.OutputType.HTML
            )
        }
    }
}

changelog {
    version = "1.0.0"
    path = file("CHANGELOG.md").canonicalPath
    header = "[${-> version.get()}] - ${ExtensionsKt.date("yyyy-MM-dd")}"
    headerParserRegex = ~/(\d+\.\d+)/
    introduction = """
        My awesome project that provides a lot of useful features, like:
        
        - Feature 1
        - Feature 2
        - and Feature 3
    """.stripIndent()
    itemPrefix = "-"
    keepUnreleasedSection = true
    unreleasedTerm = "[Unreleased]"
    groups = ["Added", "Changed", "Deprecated", "Removed", "Fixed", "Security"]
    lineSeparator = "\n"
    combinePreReleases = true
    sectionUrlBuilder = { repositoryUrl, currentVersion, previousVersion, isUnreleased -> "foo" } as ChangelogSectionUrlBuilder
    outputFile = file("release-note.txt")
}

Plugin can be configured with the following properties set in the changelog {} closure:

Note

The header closure has the delegate explicitly set to the extension's context for the sake of the Configuration cache support.

The plugin introduces the following tasks:

Retrieves changelog for the specified version.

$ ./gradlew getChangelog --console=plain -q --no-header --no-summary

### Added
- Initial project scaffold
- GitHub Actions to automate testing and deployment
- Kotlin support

$ ./gradlew getChangelog --output-file=build/changelog.md
$ cat build/changelog.md

## [1.0.0]

Initial release.

### Added
- Initial project scaffold
- GitHub Actions to automate testing and deployment
- Kotlin support

[1.0.0]: https://github.com/JetBrains/gradle-changelog-plugin/releases/tag/v1.0.0

Creates a new changelog file with an unreleased section and empty groups.

$ ./gradlew initializeChangelog
$ cat CHANGELOG.md

## [Unreleased]
### Added
- Example item

### Changed

### Deprecated

### Removed

### Fixed

### Security

Updates the unreleased section to the given version.

Warning

Content provided with the --release-note option will override the existing release note for the latest unreleased entry.

$ cat CHANGELOG.md
## [Unreleased]
### Added
- A based new feature
 
$ ./gradlew patchChangelog
$ cat CHANGELOG.md

## [Unreleased]
### Added

## [1.0.0]
### Added
- A based new feature

$ cat CHANGELOG.md
## [Unreleased]
### Added
- This note will get overridden by the `--release-note`

$ ./gradlew patchChangelog --release-note='- Foo'
$ cat CHANGELOG.md
## [Unreleased]
### Added

## [1.0.0]
- Foo

All the methods are available via the changelog extension and allow for reading the changelog file within the Gradle tasks to provide the latest (or specific) change notes.

Note

The following methods depend on the changelog extension set in the Configuration build phase. For safe access and process of your changelog file, we recommend accessing the changelog extension within Gradle closures as presented in the Usage section.

The method returns a Changelog.Item? object for the specified version. Throws MissingVersionException if the version is not available.

The method returns a Changelog.Item object for the unreleased version. Throws MissingVersionException if the version is not available.

The method returns the latest released Changelog.Item object (first on the list). Throws MissingVersionException if the version is not available.

The method checks if the given version exists in the changelog.

Renders the whole Changelog object to string based on the given outputType.

Renders the given Changelog.Item object to string based on the given outputType.

Returns the Changelog instance shared among all the tasks. See Changelog for more details.

The Changelog class is a wrapper for the Changelog file. It provides methods to read and write the changelog file.

Methods described in the above section return Changelog.Item object, which is a representation of the single changelog section for the specific version.

It provides a couple of properties and methods that allow altering the output form of the change notes:

Note

To use package-level Kotlin functions in Groovy, you need to import the containing file as a class:

import org.jetbrains.changelog.ExtensionsKt

changelog {
  header = { "[$version] - ${ExtensionsKt.date('yyyy-MM-dd')}" }
}

• IntelliJ Platform Plugin Template
• Gradle IntelliJ Plugin
• Unity Support for ReSharper and Rider

All releases are available in the Releases section. The latest available version is:

Please see CONTRIBUTING on how to submit feedback and contribute to this project.

Licensed under the Apache License, Version 2.0 (the "License"), see LICENCE.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4