Skip to content

chore(workflow): add workflow to deploy documentation as github pages #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jonperron wants to merge 1 commit into from
Closed

chore(workflow): add workflow to deploy documentation as github pages #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/deploy_documentation.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Deploy Documentation

on: [push, pull_request, workflow_dispatch]

Copilot AI Nov 11, 2025

Copy link

Choose a reason for hiding this comment

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

The workflow triggers on all push and pull_request events but only deploys on main branch pushes (line 24). This causes unnecessary workflow runs and resource usage for builds that won't be deployed. Consider triggering on 'push: branches: [main]' and 'workflow_dispatch' only, or add a conditional check earlier in the job.

Suggested change
on: [push, pull_request, workflow_dispatch]
on:
push:
branches:
- main
workflow_dispatch:

Copilot uses AI. Check for mistakes.

permissions:
contents: write

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5

Copilot AI Nov 11, 2025

Copy link

Choose a reason for hiding this comment

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

Inconsistent action version usage across workflows. Other workflows in the repository (tests.yaml and pre-commit_ci.yaml) use actions/setup-python@v4. Consider using v4 for consistency, or update all workflows to v5.

Suggested change
- uses: actions/setup-python@v5
- uses: actions/setup-python@v4

Copilot uses AI. Check for mistakes.
with:
python-version: '3.10'

Copilot AI Nov 11, 2025

Copy link

Choose a reason for hiding this comment

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

Missing pip upgrade before installing dependencies. Other workflows in the repository upgrade pip first with 'python -m pip install --upgrade pip'. This ensures the latest pip version is used and avoids potential compatibility issues.

Suggested change
python-version: '3.10'
python-version: '3.10'
- name: Upgrade pip
run: python -m pip install --upgrade pip

Copilot uses AI. Check for mistakes.
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser

Copilot AI Nov 11, 2025

Copy link

Choose a reason for hiding this comment

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

Dependencies are installed without version constraints. Consider pinning versions (e.g., 'sphinx<8', 'sphinx_rtd_theme<3', 'myst_parser<3') to ensure reproducible builds and prevent breaking changes from future dependency updates.

Suggested change
pip install sphinx sphinx_rtd_theme myst_parser
pip install 'sphinx<8' 'sphinx_rtd_theme<3' 'myst_parser<3'

Copilot uses AI. Check for mistakes.
- name: Sphinx build
run: |
sphinx-build docs _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
Loading