Plan PromptKit adoption implementation
This commit is contained in:
@@ -3,9 +3,9 @@
|
||||
Status: adoption scope recorded; implementation has not begun. Released
|
||||
PromptKit v0.18.0 is the sole development target, as directed by the user.
|
||||
[Scope decisions](#scope-decisions) record that dependency choice and the
|
||||
recommended example policy and capability scope. The
|
||||
[completion checklist](#completion-checklist) separates implementation evidence
|
||||
from publication and deferred enhancements.
|
||||
selected example policy and capability scope. The
|
||||
[implementation plan](implementation.md) owns staged work, validation commands,
|
||||
and completion evidence; this document owns the desired state and scope.
|
||||
|
||||
## Purpose and authority
|
||||
|
||||
@@ -158,12 +158,12 @@ inspection, and request preparation remain their respective upstream views.
|
||||
|
||||
### Configuration, bundle behavior, and maintained consumers
|
||||
|
||||
Migrate PromptKit-owned root and collection `prompts`, `profiles`, and `backends`
|
||||
to lists with explicit `id` values. Convert calls to `ProfileSource` and
|
||||
`BackendSource` to ordered record slices where used. Update inheritance and
|
||||
configuration-inspection paths to the new shapes. Link consumer guidance to
|
||||
upstream for whole-record replacement, source-root `config` controls, import
|
||||
requiredness, and optional version-2 specification headers.
|
||||
PromptKit-owned root and collection `prompts`, `profiles`, and `backends` use
|
||||
lists with explicit `id` values. Calls to `ProfileSource` and `BackendSource`
|
||||
use ordered record slices. Inheritance and configuration-inspection paths
|
||||
match the adopted shapes. Consumer guidance links to upstream for whole-record
|
||||
replacement, source-root `config` controls, import requiredness, and optional
|
||||
version-2 specification headers.
|
||||
|
||||
Remove maintained-example plumbing whose only role was carrying PromptKit's
|
||||
removed descriptive version. Preserve independently meaningful application
|
||||
@@ -192,10 +192,10 @@ the native capabilities made available to operators.
|
||||
### Workspace, documentation, and release preparation
|
||||
|
||||
Independent module validation uses the real downloaded dependency graph with
|
||||
workspace discovery off. Once ckprompt's types align, the ignored workspace can
|
||||
again compose root, ckconfig, and ckprompt, with a workspace Go version that
|
||||
supports its Go 1.27.0 members. Restore aligned-workspace development guidance
|
||||
and validate the maintained composed consumer with that local module set too.
|
||||
workspace discovery off. The ignored workspace composes root, ckconfig, and
|
||||
ckprompt with a Go version supporting its Go 1.27.0 members. Development guidance
|
||||
describes the aligned workspace, and the maintained composed consumer works
|
||||
with both the declared releases and the local module set.
|
||||
|
||||
Current GoDoc, CLI reports, README/module-selection guidance, maintained example
|
||||
instructions, and attribution describe the implemented dependency set and
|
||||
@@ -208,43 +208,16 @@ Publication and hosted Gitea delivery remain separate operations under the
|
||||
[release procedure](../release.md). Preparing this roadmap does not publish a
|
||||
version or select new release gates.
|
||||
|
||||
## Work from the baseline
|
||||
## Scope boundaries
|
||||
|
||||
1. Use released PromptKit v0.18.0 under OD-1 and the recommended default-bundle
|
||||
example policy under OD-2. Prepare the
|
||||
ckprompt dependency/import and Go-minimum changes with the selected Go 1.27
|
||||
toolchain, then tidy and inspect authentic metadata with workspace discovery
|
||||
off. Review the effective graph for attribution, including tool requirements.
|
||||
2. Update native API uses and remove prompt-version DTOs, output, and obsolete
|
||||
version-only tests. Preserve meaningful adapter assertions and the remaining
|
||||
report fields, provider capabilities, diagnostics, and outcome coordination.
|
||||
3. Migrate maintained configuration fixtures, programmatic resource builders,
|
||||
inheritance references, list-index paths, and composed-example plumbing.
|
||||
Apply the selected bundle policy explicitly in fixture-owned loaders.
|
||||
4. Update focused tests for request forwarding and faithful native-result
|
||||
projection, including bundled records and source evidence reaching output.
|
||||
Account for normalized inspection values and native inventories; test the
|
||||
CommandKit adaptation rather than independently establishing bundle
|
||||
contents, normalization rules, inheritance, or provider behavior.
|
||||
5. Run the full ckprompt suite and maintained example tests against its own
|
||||
declared dependencies. Validate the restored local workspace and composed
|
||||
consumer, and perform appropriate core/ckconfig regression checks. Preserve
|
||||
checks of help/preflight acquisition, selectors, aliases, repeated invocation
|
||||
state, cancellation, writer failures, and supported native error identity.
|
||||
6. Update current contract owners, dependency notices and pinned license/source
|
||||
references, and the candidate release note. Review links, examples, and
|
||||
whitespace. Record final validation and publication status separately from
|
||||
the earlier disposable review evidence. Under OD-5's recommendation, include
|
||||
native namespace-view loader guidance while keeping standard selector design
|
||||
separate.
|
||||
|
||||
The native adapter structure remains the starting point. This sprint covers
|
||||
dependency, API/report, fixture, and workspace migration plus namespace-loader
|
||||
guidance. Core APIs and its Go minimum remain unchanged. Shared metadata,
|
||||
prepared-request inspection, and reusable namespace helpers or standard selectors
|
||||
are deferred to [future work](future.md#promptkit-inspection-and-selection-extensions).
|
||||
The adoption covers dependency, API/report, fixture, and workspace alignment
|
||||
plus namespace-loader guidance. Core APIs and its Go minimum remain unchanged.
|
||||
Shared metadata, prepared-request inspection, and reusable namespace helpers or
|
||||
standard selectors are deferred to
|
||||
[future work](future.md#promptkit-inspection-and-selection-extensions).
|
||||
The shared detailed-comparison, failed-load-inventory, and structured-diagnostic
|
||||
proposals remain separate too.
|
||||
proposals remain separate too. Ordered work belongs in the
|
||||
[implementation plan](implementation.md).
|
||||
|
||||
## Released upstream baseline
|
||||
|
||||
@@ -262,7 +235,7 @@ or monitoring of unreleased work is part of this adoption.
|
||||
## Scope decisions
|
||||
|
||||
OD-1 records the user's explicit dependency direction. OD-2 through OD-5 record
|
||||
the recommended scope for this sprint; deferred capabilities still require
|
||||
the selected scope for this sprint; deferred capabilities still require
|
||||
focused API and CLI design. These decisions do not describe implemented features
|
||||
or authorize publication.
|
||||
|
||||
@@ -280,35 +253,22 @@ Application loaders continue to own engine construction and bundle choices;
|
||||
request builders continue to expose native request options without requiring a
|
||||
standard flag for each one.
|
||||
|
||||
## Completion checklist
|
||||
## Acceptance criteria
|
||||
|
||||
Record evidence against the final implementation, separately from the earlier
|
||||
disposable review. Implementation is complete when:
|
||||
The final integration uses the selected released vanity dependencies and Go
|
||||
minimum throughout production, tests, and the composed example. Its existing
|
||||
operations faithfully expose the adopted upstream results, with descriptive
|
||||
prompt-version fields removed and unrelated version meanings retained.
|
||||
|
||||
- [ ] ckprompt declares PromptKit v0.18.0, ConfigKit v1.1.0, ckconfig v0.3.0,
|
||||
and core v0.3.0 through their vanity paths, with Go 1.27.0 and authentic sums.
|
||||
Production code, tests, and the composed example exchange matching types.
|
||||
- [ ] Reports omit removed descriptive prompt-version fields while preserving
|
||||
collection release labels, source headers, and unrelated application versions.
|
||||
Native normalized inspection values and source evidence remain faithfully
|
||||
projected through existing adapters.
|
||||
- [ ] Fixtures and resource builders use the adopted configuration shapes;
|
||||
the composed example retains the default bundle, focused output checks cover
|
||||
bundle evidence, and smoke tests use their intended offline targets.
|
||||
- [ ] The full ckprompt suite and maintained example tests pass independently
|
||||
with workspace discovery off and read-only module metadata on Go 1.27.0.
|
||||
- [ ] The aligned three-module workspace and composed consumer pass validation,
|
||||
with appropriate core/ckconfig regression checks. Preserve the ignored local
|
||||
workspace, update its Go version as needed, and restore development guidance.
|
||||
No workspace files or local dependency replacements enter the release.
|
||||
- [ ] Current GoDoc, CLI report contracts, consumer/example guidance (including
|
||||
namespace views), notices, and the ckprompt v0.3.0 candidate note match the
|
||||
implemented migration. Markdown links, fragments, examples, and whitespace
|
||||
have been reviewed.
|
||||
- [ ] Final validation evidence and remaining deferred features are recorded.
|
||||
Source publication and hosted delivery are tracked separately under the
|
||||
existing release procedure.
|
||||
Maintained configuration uses the adopted resource shapes. The composed example
|
||||
retains the native bundle; CommandKit output carries its records and source
|
||||
evidence, and the default test suite and maintained smoke examples stay offline. The three modules compose in
|
||||
the local workspace while independently validating against declared releases.
|
||||
|
||||
The checklist records completion evidence; it does not add publication gates
|
||||
or require implementing deferred features. No core API change is planned for
|
||||
this adoption.
|
||||
Current contracts, consumer and namespace-loader guidance, notices, and the
|
||||
ckprompt v0.3.0 candidate note describe that implemented state. Workspace files
|
||||
and local dependency replacements are absent from release inputs. Source
|
||||
publication and hosted delivery remain separate under the existing release
|
||||
procedure. The [implementation plan](implementation.md#stage-7-validate-the-final-modules-and-workspace-then-close-the-sprint)
|
||||
owns concrete checks and their final evidence; the earlier disposable review
|
||||
is preliminary evidence only.
|
||||
|
||||
Reference in New Issue
Block a user