Repository navigation
ci: replace remote documentation checks - #642
Conversation
|
Updated workflow name to improve the presentation on GH. They appear as "workflow> / job", and I didn't like the redundancy of "Documentation checks / Spelling check". |
There was a problem hiding this comment.
The workflow changes make sense to me - thanks!
Looks like this is missing a CHANGELOG.md update, unless you have that staged elsewhere?
I also noticed that CONTRIBUTING.md still says:
Automatic documentation checks: Runs upstream documentation workflow checks. The project uses canonical/documentation-workflows for automatic documentation checks. To modify this part of CI behavior, pass inputs to upstream workflows rather than creating or customizing local copies.
Maybe that ought to be updated as part of #642? Edit: #642 is sphinx-stack-docs, so no, CONTRIBUTING.md will need updating here.
|
Thanks, @dwilding! I updated my release notes draft, but forgot to fix the supporting docs here. Should be good now. |
CHANGELOG.mdwith relevant non-documentation file changes?Replaces the remote documentation-checks actions, which point back to the parent project's Makefile, carry technical debt, and introduce security concerns. This local check makes these checks easier for users to customize and maintain locally, and has the added benefit of simplifying our architecture. The spelling and inclusive language checks are also a good bit faster.
This check was tested for correctness and performance in DOCPR-2697.
Resolves canonical/documentation-workflows#33, canonical/documentation-workflows#41, canonical/documentation-workflows#42, and canonical/documentation-workflows#44.