A brand new Release Notes feature for Releases being made by 'build.cake' script #1716
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New Feature
build.cake
scriptThis is preparation PR for upcoming release 19.1.x or a brand new 20.0.0 one. So, after delivering script upgrade to develop branch, a new release branch
release/20.0.0
will be created.Proposed Changes
ReleaseNotes.md
was renamed and content now can contain a header templates for Release Notes. Now placeholder{0}
is used to substitute current SemVer version (release version) to the release name in the headerReleaseNotes.md
file processing has changed.Old process: 1) Read all commits from Git → 2) Transform to notes item with hash, author, feature/commit message; → 3) Flush string stream to
ReleaseNotes.md
for NuGet packaging → 4) finally calling Version task and ignoring SemVer.New process: 1) Run Version task first → 2) Paste SemVer value into Release Notes placeholders → 3) Generate new Notes style 3) Flush string stream to
ReleaseNotes.md
for NuGet packaging → 4) finally not calling Version task, but reusing SemVer where applicable.CreateReleaseNotes
task completely defining new local helper functions: introduce new generator for new Notes style, use more git statistics on features delivered, create Top 3 contributors, describe release influencers, get more info on features deliveredCreateReleaseNotes
task. So, there is no sense to generateReleaseNotes.md
file for PRs. And, only Release mode on CircleCI during making a Release build for main branch will call this task. So, we will have a little bit faster PR builds. Currently we save 10-20 milliseconds 🤣DONE
status for each task after completion. Better to check the name of finished task, and watch for process chain (tasks dependencies). This can be enhanced in future.Spectre.Console
package to use fantasticAnsiConsole
helper for logging with colored messagesSamples and Examples of new Release Notes
...can be found here, in #1711 : final version of new style.
Release name (header) aka main release message
September 2023 (version 19.1.0)
was reused from Visual Code release notes 😋