gradle / gradle/foojay-toolchains

Improve crafting release notes for new plugin releases

Open
#38 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Kotlin
Stars
217
Forks
26
Avg merge
1d 18h
Merged PRs (30d)
2

Description

Currently, creating release notes for a new plugin release requires creating a dedicated file for that version, with a simple (yet undocumented) plain text format. Instead, it would be nicer if there was a single release notes file with all notes for all (past and current) releases present in the repository, so that

1. all release notes are visible at a single glance
2. the expected format is more clear by providing examples

Additionally, it would be nice if notes were already published to [GitHub releases](https://github.com/gradle/foojay-toolchains/releases).

See https://github.com/gradle/foojay-toolchains/pull/37 for context.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.