Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions .github/workflows/readme-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@ jobs:
uses: actions/checkout@v4
- name: Check README is up-to-date
run: |
cd internal/readme
make
go generate ./internal/readme
if [ -n "$(git status --porcelain)" ]; then
echo "ERROR: README.md is not up-to-date!"
echo ""
echo "The README.md file differs from what would be generated by running 'make' in internal/readme/."
echo "The README.md file differs from what would be generated by `go generate ./internal/readme`."
echo "Please update internal/readme/README.src.md instead of README.md directly,"
echo "then run 'make' in the internal/readme/ directory to regenerate README.md."
echo "then run `go generate ./internal/readme` to regenerate README.md."
echo ""
echo "Changes:"
git status --porcelain
Expand Down
19 changes: 0 additions & 19 deletions internal/readme/Makefile

This file was deleted.

22 changes: 0 additions & 22 deletions internal/readme/build.sh

This file was deleted.

9 changes: 9 additions & 0 deletions internal/readme/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Copyright 2025 The Go MCP SDK Authors. All rights reserved.
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file.

//go:generate go run golang.org/x/example/internal/cmd/weave@latest -o ../../README.md ./README.src.md

// The readme package is used to generate README.md at the top-level of this
// repo. Regenerate the README with go generate.
package readme
2 changes: 0 additions & 2 deletions mcp/mcp.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file.

//go:generate ../internal/readme/build.sh

// The mcp package provides an SDK for writing model context protocol clients
// and servers.
//
Expand Down
Loading