From 277a143654b7ba48dec196401c615456ee86e356 Mon Sep 17 00:00:00 2001 From: Justin Pierce <2170989+justin-pierce@users.noreply.github.com> Date: Sat, 11 May 2024 10:52:52 -0400 Subject: [PATCH] docs: add note about using nextRelease.notes vs changelog plugin --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0f2516ea5..8f93cce21 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,9 @@ With this example: - the shell command `./verify.sh` will be executed on the [verify conditions step](https://github.com/semantic-release/semantic-release#release-steps) - the shell command `./publish.sh 1.0.0 master 3 870668040000` (for the release of version `1.0.0` from branch `master` with `3` commits on `August 4th, 1997 at 2:14 AM`) will be executed on the [publish step](https://github.com/semantic-release/semantic-release#release-steps) -**Note**: it's required to define a plugin for the [analyze commits step](https://github.com/semantic-release/semantic-release#release-steps). If no [analyzeCommitsCmd](#analyzecommitscmd) is defined the plugin [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer) must be defined in the `plugins` list. +### Notes +* It's required to define a plugin for the [analyze commits step](https://github.com/semantic-release/semantic-release#release-steps). If no [analyzeCommitsCmd](#analyzecommitscmd) is defined the plugin [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer) must be defined in the `plugins` list. +* Using `${nextRelease.notes}` will resolve. However, in order to avoid issues when the changelog exceeds the character limit of your shell, it is recommended to use the [@semantic-release/changelog](https://github.com/semantic-release/changelog) plugin instead. ## Configuration