Skip to content

Developer friendly rework (#41) #40

Developer friendly rework (#41)

Developer friendly rework (#41) #40

Workflow file for this run

name: lazydocs
on:
push:
branches:
- main
jobs:
build-linux:
runs-on: ubuntu-latest
strategy:
max-parallel: 5
steps:
- uses: actions/checkout@v2
- name: Install Python 3
uses: actions/setup-python@v1
with:
python-version: 3.9
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install lazydocs
pip install pydocstyle
- name: Generate documentation
run: lazydocs --overview-file="README.md" --validate snirf docs
- name: Commit
run: |
echo ${{ github.ref }}
git add docs
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git commit -m "CI: Automated docs update" -a | exit 0
- name: Push
uses: ad-m/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: ${{ github.ref }}