Skip to content

Commit c45d729

Browse files
update documentation, add script and workflow
1 parent 798e674 commit c45d729

File tree

3 files changed

+613
-370
lines changed

3 files changed

+613
-370
lines changed

.github/workflows/docs-check.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Documentation Check
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
docs-check:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v4
15+
16+
- name: Set up Go
17+
uses: actions/setup-go@v5
18+
with:
19+
go-version-file: 'go.mod'
20+
21+
- name: Build docs generator
22+
run: go build -o github-mcp-server ./cmd/github-mcp-server
23+
24+
- name: Generate documentation
25+
run: ./github-mcp-server generate-docs --readme-path README.md
26+
27+
- name: Check for documentation changes
28+
run: |
29+
if ! git diff --exit-code README.md; then
30+
echo "❌ Documentation is out of date!"
31+
echo ""
32+
echo "The generated documentation differs from what's committed."
33+
echo "Please run the following command to update the documentation:"
34+
echo ""
35+
echo " go run ./cmd/github-mcp-server generate-docs"
36+
echo ""
37+
echo "Then commit the changes."
38+
echo ""
39+
echo "Changes detected:"
40+
git diff README.md
41+
exit 1
42+
else
43+
echo "✅ Documentation is up to date!"
44+
fi

0 commit comments

Comments
 (0)