Merge pull request #40 from BearToCode/main #47
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: JSdoc | |
| on: | |
| # Triggers the workflow on push events but only for the main or dev branch | |
| push: | |
| branches: [ main, dev ] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| concurrency: | |
| group: push | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - name: Set up workspace | |
| uses: actions/checkout@v3 | |
| - name: Build documention | |
| uses: andstor/[email protected] | |
| with: | |
| source_dir: ./src | |
| output_dir: ./doc | |
| config_file: jsdoc.json | |
| template: '@alexispuga/jsdoc-template' | |
| front_page: README.md | |
| - name: Auto commit | |
| run: | | |
| git add . | |
| git -c user.name='jsdoc-bot' -c user.email='[email protected]' commit -m "Doc update" || exit 0 | |
| git push | |
| env: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} |