Build doc site with mkdocs and deploy #2
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build doc site with mkdocs and deploy | |
on: | |
workflow_dispatch: | |
jobs: | |
build: | |
name: Build doc site with mkdocs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout project | |
uses: actions/checkout@v4 | |
with: | |
ref: 'master' | |
token: ${{ secrets.GITHUB_TOKEN }} | |
- name: Setup python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.10" | |
cache: 'pip' | |
- name: Install Mkdocs | |
run: pip install -r requirements.txt | |
- name: Run mkdocs and archive | |
run : | | |
mkdocs build | |
tar \ | |
--dereference --hard-dereference \ | |
--directory "site" \ | |
-cvf "${{ runner.temp }}/site.tar" \ | |
--exclude=.git \ | |
--exclude=.github \ | |
. | |
- name: Upload pages | |
uses: actions/upload-artifact@main | |
with: | |
name: github-pages | |
path: ${{ runner.temp }}/site.tar | |
retention-days: 1 | |
deploy: | |
name: Deploy site to github pages | |
needs: build | |
permissions: | |
pages: write # to deploy to Pages | |
id-token: write # to verify the deployment originates from an appropriate source | |
# Deploy to the github-pages environment | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v2 |