Skip to content

0.3.4

0.3.4 #62

Workflow file for this run

name: Build docs on push
on:
release:
types: [created]
push:
branches: [develop, main]
workflow_dispatch:
env:
DOC_REF_NAME: ${{ github.head_ref || github.ref_name }}
jobs:
build-deploy-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Document which branch
run: echo $DOC_REF_NAME
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
cache: 'pip'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Install package
run: |
pip install -e .
- name: Configure Git user
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git fetch origin gh-pages --depth=1
- name: Build docs
run: |
mike deploy --push $DOC_REF_NAME
- name: add comment to PR with documentation link
if: github.event_name != 'pull_request'
uses: mshick/add-pr-comment@v2
with:
message: |
Preview documentation at: <https://e-lo.github.io/GMNSpy/$DOC_REF_NAME>