docs: remove stale CGO onboarding requirement - #25
Merged
Conversation
Signed-off-by: Shreyansh Sancheti <43677304+shreyanshjain7174@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR removes stale CGO setup guidance. It aligns local build docs with the repo’s pure-Go SQLite setup and adds a dashboard pointer for receipt inspection.
Changes:
- Set
Makefilebuild targets toCGO_ENABLED=0. - Update contributor docs to drop the C compiler prerequisite, with a note about
-race. - Add the dashboard URL and admin-secret boundary to the README quickstart.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Adds a quickstart step pointing to /dashboard/ for viewing the receipt ledger. |
| Makefile | Switches build targets to CGO_ENABLED=0 to match pure-Go builds. |
| CONTRIBUTING.md | Removes CGO compiler requirements and documents the -race exception. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+55
to
+59
| **Inspect the receipt ledger.** Open | ||
| [`http://localhost:8080/dashboard/`](http://localhost:8080/dashboard/) and | ||
| enter the gateway URL plus `AGENTGATE_ADMIN_SECRET`. The dashboard checks the | ||
| visible receipt chain locally. Use the standalone verifier below for full | ||
| cryptographic proof. |
Comment on lines
3
to
+7
| build: | ||
| CGO_ENABLED=1 go build -o bin/agentgate ./cmd/agentgw | ||
| CGO_ENABLED=0 go build -o bin/agentgate ./cmd/agentgw | ||
|
|
||
| build-verify: | ||
| CGO_ENABLED=1 go build -o bin/agentgate-verify ./cmd/agentgate-verify | ||
| CGO_ENABLED=0 go build -o bin/agentgate-verify ./cmd/agentgate-verify |
Comment on lines
+12
to
+15
| No C compiler, database, API keys, or secrets are needed to build or run | ||
| `make test`. The SQLite driver is pure Go. Every test either uses an | ||
| in-memory/temp-file SQLite database or a local `httptest` server. The | ||
| optional `-race` check below does require a C compiler. |
Signed-off-by: Shreyansh Sancheti <43677304+shreyanshjain7174@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed:
Why:
CI, Docker, GoReleaser, and modernc.org/sqlite already use a pure-Go build. The previous Makefile and contributor prerequisite contradicted that setup and added needless setup friction for early contributors.
Verification:
make clean
make build build-verify test
git diff --check
All passed locally. The gateway was also started locally: GET /dashboard/ returned 200 and GET /dashboard redirected to /dashboard/.