Skip to content

fix: using github actions to upload and deploy#35

Merged
eschmidt42 merged 3 commits into
mainfrom
fix/documentation-ci
Sep 13, 2025
Merged

fix: using github actions to upload and deploy#35
eschmidt42 merged 3 commits into
mainfrom
fix/documentation-ci

Conversation

@eschmidt42
Copy link
Copy Markdown
Owner

@eschmidt42 eschmidt42 commented Sep 13, 2025

This pull request updates the GitHub Actions workflow for building and deploying documentation. The main focus is improving the deployment process to GitHub Pages and streamlining the documentation build steps.

Deployment and workflow improvements:

  • Added explicit permissions (contents: write, pages: write, id-token: write) to the workflow for secure deployment to GitHub Pages.
  • Replaced the manual deployment command with the peaceiris/actions-gh-pages@v4 GitHub Action for more reliable and maintainable deployment to the gh-pages branch.
  • Added an environment specification for github-pages to the build job for better environment management.

Build process simplification:

  • Updated the documentation build step to use mkdocs build -d site, ensuring the static site is generated in the correct directory.
  • Fixed minor typos in step names (e.g., "Create virtual environment") for clarity and consistency.

@codecov
Copy link
Copy Markdown

codecov Bot commented Sep 13, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.90%. Comparing base (2a232ca) to head (d09e89b).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #35   +/-   ##
=======================================
  Coverage   94.90%   94.90%           
=======================================
  Files          27       27           
  Lines        1433     1433           
=======================================
  Hits         1360     1360           
  Misses         73       73           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@eschmidt42 eschmidt42 merged commit d50a8ed into main Sep 13, 2025
5 of 6 checks passed
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.

1 participant