Skip to content

Commit 36bc3f7

Browse files
authored
Improve tagging docs
1 parent c61b317 commit 36bc3f7

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Add a step like this to your workflow:
4444
# Default: ''
4545
remove: "./dir/old_file.js"
4646

47-
# Name of the tag to add to the new commit. Use an empty string to disable tagging.
47+
# Name of the tag to add to the new commit (see the paragraph below for more info)
4848
# Default: ''
4949
tag: "v1.0.0"
5050

@@ -68,6 +68,10 @@ The script will not stop if one of the git commands fails. E.g.: if your command
6868
You can delete files with the `remove` option: that runs a `git rm` command that will stage the files in the given path for removal.
6969
The script will not stop if one of the git commands fails. E.g.: if your command shows a "fatal: pathspec 'yourFile' did not match any files" error the action will go on.
7070

71+
### Tagging:
72+
73+
You can tag commits with the `tag` option: when used, it will create a lightweight tag for the commit with the name you set as input. If not entered (or if an empty string is passed) teh action won't create any tag.
74+
7175
### Examples:
7276

7377
Do you want to lint your JavaScript files, located in the `src` folder, with ESLint, so that fixable changes are done without your intervention? You can use a workflow like this:

0 commit comments

Comments
 (0)