Skip to content

docs: add local development and testing guide - #4

Merged
viqueen merged 3 commits into
mainfrom
feature/local-dev-docs
Aug 12, 2026
Merged

docs: add local development and testing guide#4
viqueen merged 3 commits into
mainfrom
feature/local-dev-docs

Conversation

@viqueen

@viqueen viqueen commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

what

Adds a local development workflow for testing the plugins from a working tree against a real project before releasing.

  • New mise run install:local task — go install ./cmd/..., dropping both binaries onto PATH.
  • New local testing guide at _docs/guide-local-testing.md (guide- prefixed workflow doc): build/install from source, wire a consumer project (symlink the labset protos as a local buf module), and exercise both plugins with a pass/fail example.
  • Linked the guide from the README resources section and CONTRIBUTING.
  • Tightened README prose (plugin description states purpose only; resources bullet list).

verified

  • mise run install:local installs both binaries onto PATH.
  • Against a throwaway consumer project: buf lint passes and buf generate runs the mode=echo generator on a valid ROLE_ENTITY model; moving entity off field 1 trips MODEL_ENTITY_FIELD.
  • Same result wiring buf to absolute binary paths.

🤖 Generated with Claude Code

viqueen and others added 3 commits August 12, 2026 17:42
Add mise run install:local and a guide for running the plugins from source
against a project before releasing.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Trim rationale and cross-references to a plain step sequence; fence the proto
snippet as protobuf for highlighting.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
State the codegen plugin's purpose without the mode aside; replace the
contributing prose with a resources bullet list.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

The latest Buf updates on your PR. Results from workflow schema / buf (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedAug 12, 2026, 8:07 AM

@viqueen
viqueen merged commit 87f56c7 into main Aug 12, 2026
2 checks passed
@viqueen
viqueen deleted the feature/local-dev-docs branch August 12, 2026 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant