Skip to content

Commit 51d91f6

Browse files
authored
docs: add warning regarding actions/checkout@v1
fix #146
1 parent 3e8da6e commit 51d91f6

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,16 @@ You can use the `tag` option to enter the arguments for a `git add` command. In
9292
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 add the token there.
9393
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.
9494

95+
### About `actions/checkout`
96+
The token you use when setting up the repo with this action will determine what token `add-and-commit` will use.
97+
Some users reported that they were getting an error:
98+
99+
```
100+
> fatal: could not read Username for 'https://github.com': No such device or address
101+
```
102+
103+
If you're getting this error and you're using `actions/checkout@v1`, try upgrading to `actions/checkout@v2`. If you're still having problems after upgrading, feel free to open an issue. Issue ref: [#146](https://github.com/EndBug/add-and-commit/issues/146)
104+
95105
### Outputs:
96106

97107
The action provides these outputs:

0 commit comments

Comments
 (0)