Skip to content

Commit

Permalink
docs: add warning regarding actions/checkout@v1
Browse files Browse the repository at this point in the history
fix #146
  • Loading branch information
EndBug committed Mar 11, 2021
1 parent 3e8da6e commit 51d91f6
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,16 @@ You can use the `tag` option to enter the arguments for a `git add` command. In
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.
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.

### About `actions/checkout`
The token you use when setting up the repo with this action will determine what token `add-and-commit` will use.
Some users reported that they were getting an error:

```
> fatal: could not read Username for 'https://github.com': No such device or address
```

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)

### Outputs:

The action provides these outputs:
Expand Down

0 comments on commit 51d91f6

Please sign in to comment.