Clarify pom.xml index format #1428
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 Build' | |
| on: | |
| push: | |
| branches-ignore: | |
| - 'dependabot/**' | |
| paths: | |
| - 'docs/**' | |
| - '.github/**/*docs*' | |
| pull_request: | |
| paths: | |
| - 'docs/**' | |
| - '.github/**/*docs*' | |
| workflow_dispatch: | |
| env: | |
| LC_ALL: en_US.UTF-8 | |
| defaults: | |
| run: | |
| shell: bash | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| docs: | |
| name: GitHub Pages | |
| runs-on: ubuntu-latest | |
| env: | |
| BUNDLE_GEMFILE: Gemfile | |
| BUNDLE_PATH: vendor/bundle | |
| steps: | |
| - name: Harden Runner | |
| uses: step-security/harden-runner@6c3c2f2c1c457b00c10c4848d6f5491db3b629df | |
| with: | |
| egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs | |
| - name: Git Checkout | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd | |
| - name: Set up Ruby | |
| uses: ruby/setup-ruby@7372622e62b60b3cb750dcd2b9e32c247ffec26a | |
| with: | |
| ruby-version: 3.4.5 | |
| bundler-cache: true | |
| working-directory: docs | |
| - name: Build | |
| run: | | |
| ./.github/scripts/docs.sh | |
| - name: Upload artifact | |
| id: deployment | |
| # uploads an artifact from the './docs/_site' directory | |
| uses: actions/upload-pages-artifact@v5 | |
| with: | |
| path: docs/_site | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: docs | |
| if: github.ref == 'refs/heads/master' # <= Restrict deploy to master | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v5 |