diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..6d9c782 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,28 @@ +name: Documentation +on: + release: + types: [published] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - uses: actions/configure-pages@v6 + - uses: actions/checkout@v6 + - uses: actions/setup-python@v6 + with: + python-version: 3.x + - run: pipx run --with mkdocs-material mkdocs build --clean + - uses: actions/upload-pages-artifact@v4 + with: + path: site + - uses: actions/deploy-pages@v4 + id: deployment diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..1c9531a --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,18 @@ +name: Tests +on: + pull_request: + push: + branches: + - main + +jobs: + doc-warnings: + name: Check doc builds without warnings + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + - name: Build in strict mode + # The strict flag treats warnings as errors + run: pipx run --with mkdocs-material mkdocs build --clean --strict + +# TODO: test the code snippets