github.com/thanos-io/thanos@v0.32.5/.github/workflows/docs.yaml (about)

     1  name: docs
     2  
     3  on:
     4    push:
     5      branches:
     6        - main
     7      tags:
     8    pull_request:
     9  
    10  jobs:
    11    check:
    12      runs-on: ubuntu-latest
    13      name: Documentation check
    14      env:
    15        GOBIN: /tmp/.bin
    16      steps:
    17        - name: Checkout code
    18          uses: actions/checkout@v3
    19  
    20        - name: Install Go
    21          uses: actions/setup-go@v3
    22          with:
    23            go-version: 1.21.x
    24  
    25        - uses: actions/cache@v3
    26          with:
    27            path: ~/go/pkg/mod
    28            key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
    29            restore-keys: |
    30              ${{ runner.os }}-go-
    31  
    32        - uses: actions/cache@v3
    33          with:
    34            path: .mdoxcache
    35            key: ${{ runner.os }}-mdox-${{ hashFiles('docs/**/*.md', 'examples/**/*.md', 'mixin/**/*.md', '*.md') }}
    36            restore-keys: |
    37              ${{ runner.os }}-mdox-
    38  
    39        - name: Check docs
    40          run: make check-docs
    41  
    42        - name: Check examples
    43          run: make check-examples