Skip to content

Commit

Permalink
ci: ensure docs are up to date
Browse files Browse the repository at this point in the history
  • Loading branch information
froblesmartin committed Nov 24, 2024
1 parent c6e7fe9 commit f2b55eb
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Copyright 2024 Google LLC
#
# 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: Check docs are up to date
on:
pull_request:

# Declare default permissions as read only.
permissions: read-all

jobs:
docs:
name: Check docs are up to date
runs-on: ubuntu-latest
steps:
- name: Setup Go
uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
with:
go-version: "1.23"
- name: Checkout code
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Generate docs and fail if there are differences
run: |
go install ./cmd/gendocs
gendocs > /dev/null
git diff --exit-code

0 comments on commit f2b55eb

Please sign in to comment.