- Name the jobs in workflows so they can be referenced easier
- Workflow jobs won't automatically appear in the status check list, you need to search by the name and then an auto-complete prompt will appear where you can select the job as a status check:
- Skip required status checks for non-code changes by following this guide
- Status checks "on push" only wont trigger if a PR is made from a forked repo so to support that you also need "on pull_request" setup
- When doing both
on pushandon pull_requestyou will trigger double builds if you don't specify branch filters foron push. Ason pull_requestby default will pickup all commits pushed as part of the "synchronize" event, so as long as you leaveon pull_requestas the default state or specifysynchronizein the types argument then every commit will result in a new build (along with opening/reopening the PR). - TLDR; Recommendation is
on: pull_request: push: branches: - main
- When doing both
This will actually require some permissions on internal/private repos, as this repo is public there are no specific permissions required.
For my purposes, it was important to set the following on the CSpell github action if you want it to check your whole repo everytime.
This is particularly useful if you have an existing larger repo and want your initial main builds to highlight issues that you can fix later.
The other surprise was you must set the use_cspell_files field or your cspell files input will be ignored.
- uses: streetsidesoftware/cspell-action@v7
with:
incremental_files_only: false
use_cspell_files: true