github.com/cosmos/cosmos-sdk@v0.50.10/.github/workflows/build-docs.yml (about)

     1  name: Build Docs
     2  # This workflow runs when a PR is labeled with `docs`
     3  # This will check if the docs build successfully by running `make build-docs`
     4  on:
     5    pull_request:
     6      branches:
     7        - main
     8        - "release/**"
     9      paths:
    10        - "docs/**"
    11        - "x/**/*.md"
    12        - .github/workflows/deploy-docs.yml
    13        - .github/workflows/build-docs.yml
    14  
    15  permissions:
    16    contents: read
    17  
    18  jobs:
    19    check-docs-build:
    20      name: Check docs build
    21      runs-on: ubuntu-latest
    22      steps:
    23        - name: Checkout 🛎️
    24          uses: actions/checkout@v3
    25          with:
    26            persist-credentials: false
    27            fetch-depth: 0
    28  
    29        - name: Setup Node.js 🔧
    30          uses: actions/setup-node@v3
    31          with:
    32            node-version: "16.x"
    33  
    34        # npm install npm should be removed when https://github.com/npm/cli/issues/4942 is fixed
    35        - name: Build docs 🔧
    36          run: |
    37            npm install -g npm@8.5.5
    38            make build-docs