Document new tag argument

thomaseizinger · Oct 7, 2021 · 7e9f6cc · 7e9f6cc
1 parent 576342e
commit 7e9f6cc
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+-  New optional `tag` argument allowing `v`-prefixed versions
+
+### Changed
+
+-  The `version` argument is no longer required
+
+### Deprecated
+
+-  The `version` argument will be replaced in favor of the `tag` argument
+
 ## [1.2.1] - 2021-02-23
 
 ### Fixed

diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ jobs:
     - name: Update changelog
       uses: thomaseizinger/keep-a-changelog-new-release@v1
       with:
-        version: 0.6.0 # You probably want to have this dynamic :)
+        tag: v0.6.0 # You probably want to have this dynamic :)
 ```
 
 The action will do nothing else apart from modifying the changelog.