Bennett/add-and-commit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve tagging docs

Browse Source
This commit is contained in:
Federico Grandi
2020-05-17 18:17:30 +02:00
committed by GitHub
parent c61b317dea
commit 36bc3f778b
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -44,7 +44,7 @@ Add a step like this to your workflow:
# Default: ''
remove: "./dir/old_file.js"
# Name of the tag to add to the new commit. Use an empty string to disable tagging.
# Name of the tag to add to the new commit (see the paragraph below for more info)
# Default: ''
tag: "v1.0.0"
@@ -68,6 +68,10 @@ The script will not stop if one of the git commands fails. E.g.: if your command
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.
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.
### Tagging:
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.
### Examples:
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: