Skip to content
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.

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

fix(docs): Update docs deployment ci #222

Merged
merged 2 commits into from
Oct 14, 2024
Merged
Changes from all commits
Commits
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
16 changes: 13 additions & 3 deletions .github/workflows/deploy-docs.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
name: deploy-docs
on:
workflow_dispatch:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
defaults:
run:
working-directory: ./docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand All @@ -17,12 +21,18 @@ jobs:
- uses: actions/setup-python@v5
with:
python-version: 3.x
cache: "poetry"
- name: Install Poetry
run: pipx install poetry
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
- name: Setup Cache
uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
- name: Install Dependencies
run: poetry install
- name: Deploy to gh-pages
run: ​poetry run mkdocs gh-deploy --force