docs: update Backend docs #9508
Workflow file for this run
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: Hugo Docs | |
| on: | |
| push: | |
| branches: | |
| - "main" | |
| - "release/v*" | |
| paths: | |
| - 'site/**' | |
| - 'tools/make/docs.mk' | |
| pull_request: | |
| branches: | |
| - "main" | |
| - "release/v*" | |
| paths: | |
| - 'site/**' | |
| - 'tools/make/docs.mk' | |
| permissions: | |
| contents: read | |
| jobs: | |
| docs-lint: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| - uses: ./tools/github-actions/setup-deps | |
| - name: Run markdown linter | |
| uses: nosborn/github-action-markdown-cli@9b5e871c11cc0649c5ac2526af22e23525fa344d # v3.3.0 | |
| with: | |
| files: site/content/* | |
| config_file: ".github/markdown_lint_config.json" | |
| - name: Install linkinator | |
| run: npm install -g linkinator@6.0.4 | |
| - name: Check links | |
| run: make docs docs-check-links | |
| docs-build: | |
| runs-on: ubuntu-latest | |
| needs: docs-lint | |
| permissions: | |
| contents: write | |
| steps: | |
| - name: Git checkout | |
| uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1 | |
| with: | |
| submodules: true | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| - uses: ./tools/github-actions/setup-deps | |
| - name: Setup Hugo | |
| uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3.0.0 | |
| with: | |
| hugo-version: 'latest' | |
| extended: true | |
| - name: Setup Node | |
| uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.1.0 | |
| with: | |
| node-version: '18' | |
| - name: Install Site Dependencies and Build Site | |
| run: make docs | |
| # Upload docs for GitHub Pages | |
| - name: Upload GitHub Pages artifact | |
| uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1 | |
| with: | |
| # Path of the directory containing the static assets. | |
| path: site/public | |
| # Duration after which artifact will expire in days. | |
| # retention-days: # optional, default is 1 | |
| # This workflow contains a single job called "build" | |
| docs-publish: | |
| if: github.event_name == 'push' | |
| runs-on: ubuntu-latest | |
| needs: docs-build | |
| # Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
| permissions: | |
| pages: write # to deploy to Pages | |
| deployments: write | |
| id-token: write # to verify the deployment originates from an appropriate source | |
| # Deploy to the github-pages environment | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 |