Merge pull request #725 from ljhwang/patch-42 #240
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Spell Check with Typos | |
on: | |
push: | |
branches: | |
- 'main' | |
- 'GWB-*' | |
pull_request: | |
concurrency: | |
group: ${{ github.actor }}-${{ github.ref }}-typos | |
cancel-in-progress: true | |
permissions: write-all | |
jobs: | |
typos-check: | |
name: Check for new typos | |
runs-on: ubuntu-latest | |
timeout-minutes: 5 | |
steps: | |
- name: Checkout the Checkout Actions Repository | |
uses: actions/checkout@v4 | |
with: | |
persist-credentials: false | |
- name: Check spelling with typos | |
#uses: crate-ci/typos@master | |
env: | |
GH_TOKEN: "${{ github.token }}" | |
run: | | |
mkdir -p "${{ runner.temp }}/typos" | |
RELEASE_ASSET_URL="$( | |
gh api /repos/crate-ci/typos/releases/latest \ | |
--jq '."assets"[] | select(."name" | test("^typos-.+-x86_64-unknown-linux-musl\\.tar\\.gz$")) | ."browser_download_url"' | |
)" | |
wget --secure-protocol=TLSv1_3 --max-redirect=1 --retry-on-host-error --retry-connrefused --tries=3 \ | |
--quiet --output-document=- "${RELEASE_ASSET_URL}" \ | |
| tar -xz -C "${{ runner.temp }}/typos" ./typos | |
"${{ runner.temp }}/typos/typos" --version | |
"${{ runner.temp }}/typos/typos" --config .typos.toml --format json >> ${{ runner.temp }}/typos.jsonl || true | |
python -c ' | |
import sys, json | |
old = set() | |
clean = True | |
with open(sys.argv[1]) as file: | |
for line in file: | |
new = json.loads(line) | |
if new["type"] == "typo": | |
clean = False | |
print("::warning file={},line={},col={}::perhaps \"{}\" should be \"{}\".".format( | |
new["path"], new["line_num"], new["byte_offset"], | |
new["typo"], " or ".join(new["corrections"]))) | |
sys.exit(1 if not clean else 0)' "${{ runner.temp }}/typos.jsonl" |