Skip to content

ci: replace remote documentation checks - #642

Merged
jahn-junior merged 7 commits into
mainfrom
work/workflow-redesign/DOCPR-2697
Oct 17, 2026
Merged

jahn-junior merged 7 commits into
mainfrom
work/workflow-redesign/DOCPR-2697

Conversation

@jahn-junior

@jahn-junior jahn-junior commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

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.

@jahn-junior jahn-junior changed the title ci: replace documentation-workflows calls ci: replace remote documentation checks Oct 5, 2026
@jahn-junior jahn-junior added the awaiting release Will be merged for the next minor release. label Oct 5, 2026

@medubelko medubelko left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. 🚀

@jahn-junior

jahn-junior commented Oct 8, 2026 •

Copy link
Copy Markdown
Collaborator Author

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".

@dwilding dwilding left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread .github/workflows/automatic-doc-checks.yml
@jahn-junior
jahn-junior requested a review from dwilding October 9, 2026 16:20
@jahn-junior

Copy link
Copy Markdown
Collaborator Author

Thanks, @dwilding! I updated my release notes draft, but forgot to fix the supporting docs here. Should be good now.

Comment thread CHANGELOG.md
@jahn-junior
jahn-junior merged commit 27edbc6 into main Oct 17, 2026
4 checks passed
@jahn-junior
jahn-junior deleted the work/workflow-redesign/DOCPR-2697 branch October 17, 2026 01:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting release Will be merged for the next minor release.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Stop installing aspell

3 participants