Skip to content

Update CI workflows for documentation build and deployment#2063

Merged
Borda merged 5 commits intodevelopfrom
ci/docs
Jan 12, 2026
Merged

Update CI workflows for documentation build and deployment#2063
Borda merged 5 commits intodevelopfrom
ci/docs

Conversation

@Borda
Copy link
Member

@Borda Borda commented Jan 8, 2026

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:

  • Renamed the test docs workflow from "🧪 Docs Test WorkFlow 📚" to "Test Docs Build" for clarity, and changed the job name from docs-build-test to docs-build in .github/workflows/test-doc.yml. [1] [2]
  • Renamed the deploy job from deploy to docs-build-deploy in .github/workflows/publish-docs.yml for consistency.

Simplification and cleanup:

  • Removed the matrix strategy for Python version selection in both workflows and set the Python version directly to "3.10", streamlining the configuration. [1] [2]
  • Eliminated the GitHub App token creation and direct installation of mkdocs-material-insiders via a token, simplifying dependency installation in the docs deploy workflow.

Environment and deployment improvements:

  • Updated git configuration to use the ${{ github.actor }} for user name and email, improving traceability of workflow actions.
  • Moved the MKDOCS_GIT_COMMITTERS_APIKEY environment variable into the env section for both deploy steps, making environment variable management clearer.

Copilot AI review requested due to automatic review settings January 8, 2026 12:36
@Borda Borda requested a review from SkalskiP as a code owner January 8, 2026 12:36
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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>
@Borda Borda enabled auto-merge (squash) January 9, 2026 08:15
@codecov
Copy link

codecov bot commented Jan 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52%. Comparing base (bbc96e1) to head (519b75e).
⚠️ Report is 1 commits behind head on develop.

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Borda Borda disabled auto-merge January 12, 2026 14:05
@Borda Borda merged commit 8df7aea into develop Jan 12, 2026
24 checks passed
@Borda Borda deleted the ci/docs branch January 12, 2026 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants