diff --git a/crates/typos-cli/Cargo.toml b/crates/typos-cli/Cargo.toml index 002d5b8..129f7d1 100644 --- a/crates/typos-cli/Cargo.toml +++ b/crates/typos-cli/Cargo.toml @@ -25,6 +25,7 @@ pre-release-replacements = [ {file="../../CHANGELOG.md", search="", replace="\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}, ] diff --git a/docs/github-action.md b/docs/github-action.md index 9ffad81..4b181ab 100644 --- a/docs/github-action.md +++ b/docs/github-action.md @@ -1,8 +1,52 @@ # GitHub Action If you want an easy way to test your repository spelling (or a subset of files) -you can use the Typos Action! It is served from this repository, and can -easily be used as follows: +you can use the Typos Action! + +```yaml +name: Spelling + +permissions: + contents: read + +on: [pull_request] + +env: + CLICOLOR: 1 + +jobs: + spelling: + name: Spell Check with Typos + runs-on: ubuntu-latest + steps: + - name: Checkout Actions Repository + uses: actions/checkout@v4 + - name: Spell Check Repo + uses: crate-ci/typos@v1.28.4 +``` + +**Requirements:** The runner must have `wget` installed +(see +[#769](https://github.com/crate-ci/typos/issues/769) +[#1191](https://github.com/crate-ci/typos/issues/1191) +). + +## Input + +| Name | Description | Required | Default | +| ------------------ | --------------------------------------------------------------- | -------- | ---------------------------------------------------- | +| files | Files or patterns to check | false | If not defined, the default set of files are checked | +| extend_identifiers | Comma separated list of extend identifiers, like someone's name | false | not set | +| extend_words | Comma separated list of extend words. | false | not set | +| isolated | Ignore implicit configuration files | 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 | + +`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). + +### Examples ```yaml name: Test GitHub Action @@ -17,43 +61,24 @@ 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). - -Also make sure when referencing relative file paths to use `./` (e.g., `./file.txt` instead of -`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 - -| Name | Description | Required | Default | -|------|-------------|----------|---------| -| files| Files or patterns to check | false | If not defined, the default set of files are checked | -| isolated | Ignore implicit configuration files | false | false| -| config | Use a custom config file (must exist) | false | not set | -| write_changes | Writes changes on the Action's local checkout | false | false |