update precommit markdownlint and add permissions on workflow files #1261
Workflow file for this run
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: Docs | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| apidocs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: mattnotmitt/doxygen-action@v1 | |
| with: | |
| doxyfile-path: ./docs/Doxyfile | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: api-docs | |
| path: html | |
| gitbook: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 16 | |
| - uses: awalsh128/cache-apt-pkgs-action@v1 | |
| with: | |
| packages: calibre calibre-bin libxss1 libasound2 | |
| version: 1 | |
| - name: Install JS requirements | |
| working-directory: book | |
| run: | | |
| npm install | |
| - name: Build book | |
| working-directory: book | |
| run: | | |
| npx gitbook build . public | |
| npx gitbook pdf . public/cli11.pdf | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: gitbook | |
| path: book/public | |
| pages: | |
| runs-on: ubuntu-latest | |
| needs: [apidocs, gitbook] | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| if: > | |
| success() | |
| && github.ref == 'refs/heads/main' | |
| && github.repository == 'CLIUtils/CLI11' | |
| steps: | |
| - uses: actions/configure-pages@v5 | |
| id: pages | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: api-docs | |
| path: _site | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: gitbook | |
| path: _site/book | |
| - uses: actions/upload-pages-artifact@v3 | |
| - uses: actions/deploy-pages@v4 | |
| id: deployment |