adds info about generating RELEASE_HEAD.md to readme and changelog

CSchoel · Feb 11, 2022 · 0f23ad2 · 0f23ad2
1 parent 4c221d6
commit 0f23ad2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,12 @@ nothing
 
 nothing
 
+## [1.3.0] - 2022-02-11
+
+### Added
+
+* RELEASE_HEAD.md is not created from README.md if it does not exist yet.
+
 ## [1.2.0] - 2022-01-11
 
 ### Added

diff --git a/README.md b/README.md
@@ -5,7 +5,9 @@ Release-notes-from-changelog is a GitHub action for extracting release notes fro
 For this action to work you need a file in your repository called `RELEASE_HEAD.md` that contains any header text that you want to add to all your releases.
 This can be, for example, a short sentence explaining the general purpose of the project, or simply a note that the following text was extracted from a changelog.
 
-It can be used as follows:
+If `RELEASE_HEAD.md` does not exist, the first-level heading and first paragraph of the file `README.md` will be used instead.
+
+The action can be used as follows:
 
 ```yaml
 jobs: