Skip to content

Commit b09a3f1

Browse files
ocean90EndBug
andauthored
docs: update explanation for token input (#125)
* chore(docs): Update explanation for token input * docs: move token info to dedicated paragraph * Fix typos Co-authored-by: Federico Grandi <[email protected]>
1 parent 299226a commit b09a3f1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Add a step like this to your workflow:
5959
# Default: ''
6060
tag: 'v1.0.0 --force'
6161

62-
# Token to use for pushing the commit. The default value won't trigger any workflows, you need to use a Personal Access Token for that.
62+
# The token to use to access the GitHub API when getting the author info (see the paragraph below for more info about the tokens used by the action)
6363
# Default: secrets.GITHUB_TOKEN
6464
token: ${{ secrets.GITHUB_TOKEN }}
6565
```
@@ -91,6 +91,12 @@ One way to use this is if you want to force push to a branch of your repo: you'l
9191

9292
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).
9393

94+
### Tokens:
95+
96+
The token from the `token` input is only used when getting the author info from the GitHub API: usually the default GitHub token is enough but if for some reason you want to change it, you can use that input.
97+
When pushing, the action uses the token that the local git repository has been configured with: that means that if you want to change it you'll need to do it in the steps that run before this action. For example: if you set up your repo with [`actions/checkout`](https://github.com/actions/checkout/) then you have to change the token there.
98+
Changing the token with which the repo is configured can be useful if you want to run CI checks on the commit pushed by this action; anyway, it has to be set up outside of this action.
99+
94100
### Outputs:
95101

96102
The action provides these outputs:

0 commit comments

Comments
 (0)