Fix plugin scaffold release versioning#872
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the plugin scaffolding/tooling so generated plugin repositories avoid plugin.json version churn by committing a stable 0.0.0 sentinel, while ensuring release builds still expose the real version via ldflags + sdk.ResolveBuildVersion. It also tightens the generated release workflows (pinned action SHAs + release contract gates) and adds/refreshes package docs for the plugin SDK surfaces.
Changes:
- Keep generated
plugin.jsonversions fixed at0.0.0(sentinel) instead of syncing to release versions. - Inject release version metadata into generated plugin binaries (GoReleaser ldflags /
Versionvar +ResolveBuildVersion) and wire it throughsdk.WithBuildVersion. - Add/refresh scaffolded release workflows (wfctl contract validation steps, pinned action refs) and add package/API docs.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| plugin/sdk/manifest.go | Adjusts top-of-file documentation framing for the plugin SDK manifest helpers. |
| plugin/sdk/generator.go | Changes scaffold defaults (sentinel versioning, Go version, GoReleaser ldflags) and updates generated release workflow steps. |
| plugin/sdk/generator_test.go | Updates/extends generator tests to assert sentinel versioning + build-version injection + workflow contents. |
| plugin/sdk/doc.go | Adds package documentation for the authoring/scaffolding SDK. |
| plugin/external/sdk/interfaces.go | Adds richer docs for runtime SDK interfaces/types and exports telemetry aliases for plugin authors. |
| plugin/external/sdk/doc.go | Adds package documentation and a canonical Serve(..., WithBuildVersion(...)) example for runtime SDK consumers. |
| plugin/doc.go | Adds package documentation describing host-side plugin primitives and where plugin authors should look instead. |
| cmd/wfctl/templates/ui-plugin/plugin.go.tmpl | Adds Version var + resolves runtime version via ResolveBuildVersion. |
| cmd/wfctl/templates/ui-plugin/main.go.tmpl | Passes build version into sdk.Serve via sdk.WithBuildVersion. |
| cmd/wfctl/templates/ui-plugin/.github/workflows/release.yml.tmpl | Adds wfctl setup + contract validation gates + ldflags version injection to the UI plugin release workflow template. |
| cmd/wfctl/templates/plugin/plugin.go.tmpl | Adds Version var + resolves runtime version via ResolveBuildVersion. |
| cmd/wfctl/templates/plugin/main.go.tmpl | Passes build version into sdk.Serve via sdk.WithBuildVersion. |
| cmd/wfctl/templates/plugin/.github/workflows/release.yml.tmpl | Adds wfctl setup + contract validation gates + ldflags version injection to the plugin release workflow template. |
| cmd/wfctl/plugin.go | Deprecates -version for wfctl plugin init and defaults it to the stable sentinel. |
| cmd/wfctl/plugin_init_test.go | Asserts wfctl plugin init produces plugin.json with the stable 0.0.0 sentinel version. |
Codecov Report❌ Patch coverage is
📢 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.
Summary
Closes #871
TDD invariant proof
With fix reverted:
With fix restored:
Verification