Commite9c8b40

committed

update documentation, add script and workflow

1 parent798e674 commite9c8b40Copy full SHA for e9c8b40

File tree

+751

-415

lines changed

+751

-415

lines changed

Lines changed: 47 additions & 0 deletions

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

Comments

(0)