Skip to content

Fix deployment of documentation #435

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

Merged
psomhorst merged 7 commits into from
Aug 27, 2025
Merged

Fix deployment of documentation #435

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
addfa75
Remove build documentation on push to develop
psomhorst Aug 27, 2025
395b82f
Remove superfluous permissions and strategy fields
psomhorst Aug 27, 2025
1dd49f6
Split off linking notebooks
psomhorst Aug 27, 2025
ede5cfb
Don't build docs before build and deploy on push to main
psomhorst Aug 27, 2025
2bff2d7
Update git user config
psomhorst Aug 27, 2025
4a78ad3
Rename step to reflect build and deploy
psomhorst Aug 27, 2025
06199d1
Add GH_PAT to checkout to properly set up permissions
psomhorst Aug 27, 2025
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
18 changes: 8 additions & 10 deletions .github/workflows/test_build_documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on:
push:
branches:
- main
- develop
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
branches:
Expand All @@ -16,25 +15,24 @@ jobs:
if: github.event.pull_request.draft == false
name: Build documentation
runs-on: ubuntu-latest
permissions:
pages: write
strategy:
fail-fast: false
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GH_PAT }}
- uses: ./.github/actions/install_eitprocessing
with:
dependencies: docs
extract-data: false
python-version: "3.10"
- name: Link notebooks
run: ln -s ../../notebooks docs/examples
- name: Build documentation
run: |
ln -s ../../notebooks docs/examples
mkdocs build
- name: Deploy documentation
if: ${{ !(github.event_name == 'push' && github.ref == 'refs/heads/main') }}
run: mkdocs build
- name: Build and deploy documentation
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
run: |
GIT_COMMITTER_NAME=ci-bot GIT_COMMITTER_EMAIL=ci-bot@github.com \
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
mike deploy --push --update-aliases $(git describe --tags --abbrev=0 | sed -E 's/^([vV]?[0-9]+\.[0-9]+).*/\1/') latest