actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2025-02-13 08:40:29 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(action): Document write_changes in Variables section

Browse source
This commit is contained in:
Ed Page 2024-12-30 08:05:49 -06:00
parent 478eb0f2b9
commit 33db012840
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/github-action.md
View file

@ -45,10 +45,6 @@ a release or commit as a version, and not a branch (which is a moving target).
Also make sure when referencing relative file paths to use `./` (e.g., `./file.txt` instead of Also make sure when referencing relative file paths to use `./` (e.g., `./file.txt` instead of
`file.txt`. `file.txt`.
`write_changes` doesn't commit or push anything to the branch. It only writes the changes locally
to disk, and this can be combined with other actions, for instance that will [submit code
suggestions based on that local diff](https://github.com/getsentry/action-git-diff-suggestions).
## Variables ## Variables
| Name | Description | Required | Default | | Name | Description | Required | Default |
@ -59,3 +55,7 @@ suggestions based on that local diff](https://github.com/getsentry/action-git-di
| isolated | Ignore implicit configuration files | false | false | | isolated | Ignore implicit configuration files | false | false |
| write_changes | Writes changes on the Action's local checkout | false | false | | write_changes | Writes changes on the Action's local checkout | false | false |
| config | Use a custom config file (must exist) | false | not set | | config | Use a custom config file (must exist) | false | not set |
`write_changes`: doesn't commit or push anything to the branch. It only writes the changes locally
to disk, and this can be combined with other actions, for instance that will [submit code
suggestions based on that local diff](https://github.com/getsentry/action-git-diff-suggestions).