docs(main): add GOWORK=off prefix to build/test/lint commands#728
Merged
Conversation
External contributors with a multi-repo GoCodeAlone workspace hit inconsistent build failures unless GOWORK=off is set. The plugin CONTRIBUTING templates were updated in workflow#721 + 12 plugin PRs; this PR brings the workflow main repo's own CLAUDE.md + CONTRIBUTING.md into line. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates contributor-facing documentation to recommend GOWORK=off when working inside a parent go.work multi-repo workspace, ensuring commands run against this repository’s own go.mod (aligning with the established pattern used elsewhere in the repo/docs).
Changes:
- Documented when/why to use
GOWORK=offfor multi-repo workspace contributors. - Updated build/test/lint example commands to include
GOWORK=offwhere applicable. - Added a brief clarification that
GOWORK=offis harmless when working standalone.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds GOWORK=off guidance and updates example commands for building/testing/linting. |
| CLAUDE.md | Adds GOWORK=off guidance for common tasks and updates example commands accordingly. |
| ```bash | ||
| # Go checks | ||
| # Go checks (prefix with GOWORK=off if you have a parent go.work file) | ||
| go fmt ./... |
| cd ui && npm install && npm run dev | ||
|
|
||
| # Lint | ||
| go fmt ./... |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
⏱ Benchmark Results✅ No significant performance regressions detected. benchstat comparison (baseline → PR)
|
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.
Workflow main repo CLAUDE.md + CONTRIBUTING.md now document the GOWORK=off pattern for multi-repo contributors. Sibling to workflow#721.