verify-docs.yaml

#
# Copyright 2022 The Sigstore Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: API Docs Generator

on:
  workflow_dispatch:
  push:
    branches: ['main', 'release-*']
  pull_request:

permissions: read-all

jobs:
  verify-docs:
    name: Verify API docs
    runs-on: ubuntu-latest

    env:
      GOPATH: ${{ github.workspace }}

    steps:
    - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
      with:
        path: ./src/github.com/${{ github.repository }}
        fetch-depth: 0

    - uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2
      with:
        go-version-file: './src/github.com/${{ github.repository }}/go.mod'
        check-latest: true

    - shell: bash
      working-directory: ./src/github.com/${{ github.repository }}
      run: |
        make docs

        # For whatever reason running this makes it not complain...
        git status

    - uses: chainguard-dev/actions/nodiff@4ba8d060251254fc0e65500a8d3a90013a22a8d7 # main
      with:
        path: ./src/github.com/${{ github.repository }}
        fixup-command: "make docs"