FilesExpand file tree

main

/

docs-check.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

50 lines (42 loc) · 1.29 KB

main

/

docs-check.yml

Copy path

Top

File metadata and controls

• Code
• Blame

50 lines (42 loc) · 1.29 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

name: Documentation Check

on:

push:

branches: [ main ]

pull_request:

branches: [ main ]

permissions:

contents: read

jobs:

docs-check:

runs-on: ubuntu-latest

steps:

- name: Checkout code

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7

- name: Build UI

uses: ./.github/actions/build-ui

- name: Set up Go

uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7

with:

go-version-file: 'go.mod'

- name: Build docs generator

run: go build -o github-mcp-server ./cmd/github-mcp-server

- name: Generate documentation

run: ./github-mcp-server generate-docs

- name: Check for documentation changes

run: |

if ! git diff --exit-code README.md; then

echo "❌ Documentation is out of date!"

echo ""

echo "The generated documentation differs from what's committed."

echo "Please run the following command to update the documentation:"

echo ""

echo " go run ./cmd/github-mcp-server generate-docs"

echo ""

echo "Then commit the changes."

echo ""

echo "Changes detected:"

git diff README.md

exit 1

else

echo "✅ Documentation is up to date!"

fi