Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request modernizes and simplifies the documentation CI workflows by removing unnecessary complexity and improving maintainability. The changes streamline job configurations and dependency management while maintaining the same core functionality.
Key changes:
- Simplified workflow names and job identifiers for better clarity and consistency
- Removed matrix strategies and hardcoded Python version to "3.10" to eliminate unnecessary complexity
- Transitioned from mkdocs-material-insiders to the public mkdocs-material package, eliminating the need for GitHub App token authentication
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.github/workflows/test-doc.yml |
Updated workflow name to "Test Docs Build", renamed job from docs-build-test to docs-build, removed matrix strategy, and hardcoded Python 3.10 |
.github/workflows/publish-docs.yml |
Renamed job from deploy to docs-build-deploy, removed matrix strategy and GitHub App token creation, switched to public mkdocs-material, improved environment variable handling by moving MKDOCS_GIT_COMMITTERS_APIKEY to env section, and updated git config to use github.actor |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #2063 +/- ##
=======================================
Coverage 52% 52%
=======================================
Files 61 61
Lines 7077 7077
=======================================
Hits 3657 3657
Misses 3420 3420 🚀 New features to boost your workflow:
|
Borda
commented
Jan 12, 2026
SkalskiP
approved these changes
Jan 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation-related GitHub Actions workflows by simplifying job names, removing unnecessary matrix strategies, and improving environment variable handling. It also updates the naming conventions for better clarity and maintainability.
Workflow job and naming updates:
docs-build-testtodocs-buildin.github/workflows/test-doc.yml. [1] [2]deploytodocs-build-deployin.github/workflows/publish-docs.ymlfor consistency.Simplification and cleanup:
"3.10", streamlining the configuration. [1] [2]mkdocs-material-insidersvia a token, simplifying dependency installation in the docs deploy workflow.Environment and deployment improvements:
${{ github.actor }}for user name and email, improving traceability of workflow actions.MKDOCS_GIT_COMMITTERS_APIKEYenvironment variable into theenvsection for both deploy steps, making environment variable management clearer.