Publish fix #249
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: build api documentation | |
on: | |
pull_request: | |
types: | |
- closed | |
push: | |
branches: | |
- "*" | |
jobs: | |
build_documentation: | |
if: github.event.pull_request.merged == true | |
name: generate api markdown docs | |
runs-on: ubuntu-latest | |
env: | |
CLIENT_ID: ${{ secrets.CLIENT_ID }} | |
CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }} | |
steps: | |
- name: Check out repo's default branch | |
uses: actions/checkout@v3 | |
- name: Setup python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: '3.10' | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r requirements.txt | |
pip install lazydocs | |
- name: Build docs from docstrings | |
continue-on-error: true | |
run: | | |
lazydocs --output-path="docs" --overview-file="README.md" --src-base-url="https://github.com/MLMI2-CSSI/foundry/tree/main" . | |
- name: Commit files | |
run: | | |
echo ${{ github.ref }} | |
git add . | |
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 documentation build" -a | exit 0 | |
git push origin ${{ github.event.pull_request.base.ref }} |