Skip to content

Commit

Permalink
PR: Add job to detect readme toc out of date
Browse files Browse the repository at this point in the history
  • Loading branch information
shahzadlone committed Jun 7, 2024
1 parent 9eee6de commit a7fa2b6
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/check-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,28 @@ jobs:
fail-if-changed: true
files: |
docs/website/references/http
check-readme-toc:
name: Check readme toc job

runs-on: ubuntu-latest

steps:
- name: Checkout code into the directory
uses: actions/checkout@v3

- name: Setup Go environment explicitly
uses: actions/setup-go@v3
with:
go-version: "1.21"
check-latest: true

- name: Try generating readme toc
run: make toc

- name: Check no new changes exist
uses: tj-actions/verify-changed-files@v20
with:
fail-if-changed: true
files: |
README.md

0 comments on commit a7fa2b6

Please sign in to comment.