Build API documentation #6
This file contains hidden or 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: | |
| workflow_dispatch: | |
| inputs: | |
| logLevel: | |
| description: 'Log level' | |
| required: true | |
| default: 'warning' | |
| type: choice | |
| options: | |
| - info | |
| - warning | |
| - debug | |
| tags: | |
| description: 'API documentation' | |
| required: false | |
| type: boolean | |
| permissions: | |
| contents: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: '22' | |
| - name: Install dependencies | |
| run: npm i | |
| - name: Delete default docs directory | |
| run: | | |
| git rm --cached -r docs | |
| rm -rf docs | |
| - name: Generate docs | |
| run: npm run doc | |
| - name: Git commit report | |
| run: | | |
| git config --global user.name 'hydroperfox' | |
| git config --global user.email 'hydroperfox@gmail.com' | |
| git switch -C docs | |
| git rm --cached -r . | |
| git add -f docs | |
| git commit -m "Automated report" | |
| git push origin -f docs |