actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2025-01-25 16:09:03 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(action): Demonstrate pinning actions

Browse source
This commit is contained in:
Ed Page 2024-12-30 08:18:02 -06:00
parent aa90140690
commit bb2758bfa3
2 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
crates/typos-cli/Cargo.toml
View file

@ -25,6 +25,7 @@ pre-release-replacements = [
{file="../../CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/crate-ci/typos/compare/{{tag_name}}...HEAD", exactly=1},
{file="../../action/entrypoint.sh", search="VERSION=.*", replace="VERSION={{version}}", min=1},
{file="../../docs/pre-commit.md", search="rev: .*", replace="rev: {{tag_name}}", exactly=1},
{file="../../docs/github-action.md", search="uses: crate-ci/typos@.*", replace="uses: crate-ci/typos@{{tag_name}}", min=1},
{file="../../setup.py", search="TYPOS_VERSION = .*", replace="TYPOS_VERSION = '{{version}}'", exactly=1},
]

11
docs/github-action.md
View file

@ -17,31 +17,28 @@ jobs:
uses: actions/checkout@v4
- name: Check spelling of file.txt
uses: crate-ci/typos@master
uses: crate-ci/typos@v1.28.4
with:
files: ./file.txt
- name: Use custom config file
uses: crate-ci/typos@master
uses: crate-ci/typos@v1.28.4
with:
files: ./file.txt
config: ./myconfig.toml
- name: Ignore implicit configuration file
uses: crate-ci/typos@master
uses: crate-ci/typos@v1.28.4
with:
files: ./file.txt
isolated: true
- name: Writes changes in the local checkout
uses: crate-ci/typos@master
uses: crate-ci/typos@v1.28.4
with:
write_changes: true
```
**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).
## Input
| Name | Description | Required | Default |