fix(docs): fix zero linerate in docs, prepare for release π (#23) #1
Workflow file for this run
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: publish | |
on: | |
push: | |
tags: | |
- "*.*.*" | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
build_and_publish_pypi: | |
runs-on: ubuntu-latest | |
if: github.repository_owner == 'statnett' | |
permissions: | |
id-token: write | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Install Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.12 | |
- name: install poetry | |
run: | | |
python -m pip install --upgrade pip wheel pipx | |
python -m pipx install poetry | |
- name: install dependencies | |
run: | | |
poetry install | |
poetry self add "poetry-dynamic-versioning[plugin]" | |
- name: run tests and linter | |
run: | | |
poetry run pytest | |
poetry run flake8 . | |
poetry run black --check . | |
poetry run isort -c . | |
- name: build package | |
run: | | |
poetry build | |
- name: Publish package distributions to PyPI | |
uses: pypa/gh-action-pypi-publish@release/v1 | |
build_docs: | |
needs: build_and_publish_pypi | |
runs-on: ubuntu-latest | |
if: github.repository_owner == 'statnett' | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Install Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.12 | |
- name: install poetry | |
run: | | |
python -m pip install --upgrade pip wheel pipx | |
python -m pipx install poetry | |
- name: install dependencies | |
run: | | |
poetry install --with docs | |
- name: build docs | |
run: | | |
cd docs | |
poetry run make html | |
- name: Setup Pages | |
id: pages | |
uses: actions/configure-pages@v5 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: docs/_build/html | |
# Deployment job | |
deploy_docs: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: build_docs | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |