Skip to content

Commit 0930a0f

Browse files
committed
docs(README): add tag_push and tag_pushed
1 parent 0e4f5f6 commit 0930a0f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,10 @@ Add a step like this to your workflow:
8484
# Arguments for the git tag command (the tag name always needs to be the first word not preceded by an hyphen)
8585
# Default: ''
8686
tag: 'v1.0.0 --force'
87+
88+
# Arguments for the git push --tags command (any additional argument will be added after --tags)
89+
# Default: ''
90+
tag_push: '--force
8791
```
8892
8993
### Git arguments
@@ -130,7 +134,9 @@ If you want to commit files "across different branches", here are two ways to do
130134

131135
### Tagging
132136

133-
You can use the `tag` option to enter the arguments for a `git add` command. In order for the action to isolate the tag name from the rest of the arguments, it should be the first word not preceded by an hyphen (e.g. `-a tag-name -m "some other stuff"` is ok).
137+
You can use the `tag` option to enter the arguments for a `git add` command. In order for the action to isolate the tag name from the rest of the arguments, it should be the first word not preceded by an hyphen (e.g. `-a tag-name -m "some other stuff"` is ok).
138+
You can also change the arguments of the push command for tags: every argument in the `tag_push` input will be appended to the `git push --tags` command.
139+
For more info on how git arguments are parsed, see [the "Git arguments" section](#git-arguments).
134140

135141
## Outputs
136142

@@ -141,6 +147,7 @@ The action provides these outputs:
141147
- `commit_sha`: the short 7-character SHA of the commit that has just been created
142148
- `pushed`: whether the action has pushed to the remote (`'true'` or `'false'`)
143149
- `tagged`: whether the action has created a tag (`'true'` or `'false'`)
150+
- `tag_pushed`: whether the action has pushed a tag (`'true'` or `'false'`)
144151

145152
For more info on how to use outputs, see ["Context and expression syntax"](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions).
146153

0 commit comments

Comments
 (0)