Can we provide a custom spell list and ignore list?

[kalenmike]

We don't want to run spellcheck on package file names, can we ignore package and requirement files? Also can we provide a custom word list to ignore exceptions for strange spellings?

[glenn-jocher]

@kalenmike yes, I've been thinking the same thing. As the actions grow there are a few options here, but they each have their drawbacks:

Single Repo - Single Branch (current approach, comingling arguments)

jobs:
  ultralytics-actions:
    runs-on: ubuntu-latest
    steps:
      - name: Run Ultralytics Formatting
        uses: ultralytics/actions@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }} # automatically generated, do not modify
          actions-arg1:
          actions-arg2:
          ...

Single Repo - Multi Branch (non-conventional, more complicated to maintain)

Here a single repo supports multiple branches that are named for their step, i.e. format branch and summary branches, etc.

jobs:
  ultralytics-actions:
    runs-on: ubuntu-latest
    steps:
      - name: Run Ultralytics Formatting
        uses: ultralytics/actions@format
        with:
          token: ${{ secrets.GITHUB_TOKEN }} # automatically generated, do not modify
          format-arg1:
          format-arg2:
          ...

      - name: Run Ultralytics Summary
        uses: ultralytics/actions@summary
        with:
          token: ${{ secrets.GITHUB_TOKEN }} # automatically generated, do not modify
          summary-arg1:
          summary-arg2:
          ...

Multi Repo (higher maintenance, duplication of effort, etc.)

Here a single repo supports a single step in it's main branch. The downside here is we would have to maintain multiple repos in parallel (i.e. https://github.com/ultralytics/actions-format and https://github.com/ultralytics/actions-summary and future repos), multiplying maintenance and having to repeat actions across repos (like approving dependabot updates etc.)

Main advantage is capability to publish multiple actions to the Marketplace.

jobs:
  ultralytics-actions:
    runs-on: ubuntu-latest
    steps:
      - name: Run Ultralytics Formatting
        uses: ultralytics/actions-format@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }} # automatically generated, do not modify
          format-arg1:
          format-arg2:
          ...

      - name: Run Ultralytics Summary
        uses: ultralytics/actions-summary@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }} # automatically generated, do not modify
          summary-arg1:
          summary-arg2:
          ...

[glenn-jocher]

@kalenmike another faster option is just to update the default spellchecker ignore lists here:

actions/action.yml

Lines 121 to 127 in 6e36e15

	- name: Run Codespell
	if: inputs.spelling == 'true' && github.event.action != 'closed'
	run: |
	codespell \
	-w \
	--ignore-words-list "crate,nd,ned,strack,dota,ane,segway,fo,gool,winn,commend,bloc,nam,afterall" \
	--skip "*.pt,*.pth,*.torchscript,*.onnx,*.tflite,*.pb,*.bin,*.param,*.mlmodel,*.engine,*.npy,*.data*,*.csv,*pnnx*,*venv*,*translat*,__pycache__*,*.ico,*.jpg,*.png,*.mp4,*.mov,/runs,/.git,./docs/??/*.md,./docs/mkdocs_??.yml"