Skip to content

Commit 07d7473

Browse files
committed
Update readme
Add info about available inputs.
1 parent 48bb669 commit 07d7473

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,23 @@ jobs:
2424
github-token: ${{ secrets.GITHUB_TOKEN }}
2525
```
2626
27+
## Inputs
28+
29+
### Required inputs
30+
31+
- `commit-msg`: a text used as a commit message
32+
- `file-path`: a path to file to be updated
33+
- `github-token`: GitHub token
34+
35+
### Optional inputs
36+
37+
- `branch`: branch to push changes (`master` by default)
38+
- `allow-removing`: allow to remove file if local copy is missing
39+
(`false` by default)
40+
41+
Note that the action will produce an error iflocal copy is missing,
42+
and the `allow-removing` flag is `false`.
43+
2744
## License
2845

2946
See the [license file][License].

0 commit comments

Comments
 (0)