Merge pull request #140 from Baystation12/dev #13
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: Generate Documentation | |
| permissions: | |
| contents: read | |
| on: | |
| push: | |
| branches: | |
| - dev | |
| workflow_dispatch: # allows this workflow to be manually triggered | |
| env: | |
| SPACEMAN_DMM_VERSION: suite-1.9 | |
| jobs: | |
| PreFlight: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: checkout | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 | |
| - name: paths-filter | |
| uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 | |
| id: filter | |
| with: | |
| filters: .github/workflow-config/preflight-filters.yml | |
| outputs: | |
| dm: ${{ steps.filter.outputs.dm }} | |
| generate_documentation: | |
| permissions: | |
| contents: write # required to push the doc commit | |
| runs-on: ubuntu-22.04 | |
| needs: PreFlight | |
| if: | | |
| (needs.PreFlight.outputs.dm == 'true') && | |
| !contains(github.event.head_commit.message, '[ci skip]') | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| steps: | |
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 | |
| - name: Setup Cache | |
| uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a | |
| with: | |
| path: ~/spaceman_dmm/${{ env.SPACEMAN_DMM_VERSION }} | |
| key: ${{ runner.os }}-spacemandmm-${{ env.SPACEMAN_DMM_VERSION }} | |
| - name: Install dmdoc | |
| run: scripts/install-spaceman-dmm.sh dmdoc | |
| - name: Generate documentation | |
| run: | | |
| ~/dmdoc | |
| - name: Deploy | |
| uses: JamesIves/github-pages-deploy-action@881db5376404c5c8d621010bcbec0310b58d5e29 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: gh-pages | |
| folder: dmdoc | |
| target-folder: docs | |
| clean: true |