actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-11-25 02:20:58 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: document writing_changes in the Github action

Browse source
This commit is contained in:
Benjamin Bouvier 2023-02-08 15:04:16 +01:00
parent 9b470bbbb2
commit c24f4675b8
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/github-action.md
View file

@ -32,13 +32,23 @@ jobs:
with: with:
files: ./file.txt files: ./file.txt
isolated: true isolated: true
- name: Writes changes in the local checkout
uses: crate-ci/typos@master
with:
write_changes: true
``` ```
**Important** for any of the examples above, make sure that you choose **Important** for any of the examples above, make sure that you choose
a release or commit as a version, and not a branch (which is a moving target). 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 |
@ -46,3 +56,4 @@ Also make sure when referencing relative file paths to use `./` (e.g., `./file.t
| files| Files or patterns to check | false | If not defined, entire repository is checked | | files| Files or patterns to check | false | If not defined, entire repository is checked |
| isolated | Ignore implicit configuration files | false | false| | isolated | Ignore implicit configuration files | 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 | Writes changes on the Action's local checkout | false | false |