Skip to content

Commit

Permalink
ci(docs): deploy mkdocs to GH Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
thekaveman committed May 7, 2024
1 parent bbf8b84 commit 0e5dd7b
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: MkDocs Publish
on:
workflow_dispatch:
push:
branches:
- main
paths:
- "toggl_py/docs/**"
- "toggl_py/mkdocs.yml"

defaults:
run:
shell: bash

jobs:
test:
uses: ./.github/workflows/pytest.yml

mkdocs:
name: Publish docs
runs-on: ubuntu-latest
needs: test
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Download coverage report
uses: actions/download-artifact@v4
with:
name: coverage-report
path: toggl_py/docs/coverage

- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
REQUIREMENTS: toggl_py/docs/requirements.txt
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 comments on commit 0e5dd7b

Please sign in to comment.