Subrepos
Submodules enable a git repository to reference other git repositories.
Disclaimers
- I generally don't use submodules or subtrees (an alternative to submodules).
- Handled submodules/subtrees can result in additional security vulnerabilities.
- There are different approaches to checking them out to try to avoid tripping over the previous point...
- GitHub doesn't appear to allow annotations on items from submodules (as subtrees are mostly treated as normal files in a git repository, this is less of an issue)
Workaround
If you need something before this feature is implemented, you can basically remove the .git directory, do a git init, a git add ., and a git commit before check-spelling runs.
Implementation
v0.0.25 includes initial support for submodules.
Whether you use actions/checkout yourself or use checkout, you can add submodules:
with:
submodules: true
or
with:
submodules: recursive
to the check-spelling configuration to enable check-spelling to check files in submodules.
If using checkout, check-spelling will try to check out your submodules (it has some additional code to avoid tripping on broken submodules, because this stuff is a mess).
check-spelling will list files from submodules and check them as long as they aren't excluded by your normal excludes configuration.
Files with issues will have annotated links to their origin repositories.
SARIF reports will include their paths, but GitHub will not be happy about them because the files are not part of the main repository. (Other tools that consume the files should be happy as long as they are present in your working repository.)
FAQ | Showcase | Event descriptions | Configuration information | Known Issues | Possible features | Deprecations | Release notes | Helpful scripts