Move Promptkit to its vanity module path
This commit is contained in:
@@ -1,7 +1,8 @@
|
||||
# Configuration And API Migration
|
||||
|
||||
This breaking pre-v1 minor migration changes the v0.16-era keyed resources to
|
||||
identified lists, adopts ConfigKit v1, and removes prompt-version labels.
|
||||
This breaking pre-v1 minor migration adopts Promptkit's vanity module path,
|
||||
changes the v0.16-era keyed resources to identified lists, adopts ConfigKit v1,
|
||||
and removes prompt-version labels.
|
||||
Promptkit does not install a provider catalog; applications choose configuration
|
||||
inputs explicitly, and execution selects one prompt by its exact ID. This guide
|
||||
explains the shape changes and decisions an application must make; it is not an
|
||||
@@ -9,6 +10,30 @@ automatic migration tool. The [framework format reference](../formats.md) owns
|
||||
the current configuration contract, and the root package GoDoc owns exact API
|
||||
signatures and errors.
|
||||
|
||||
## Update Go Imports
|
||||
|
||||
Promptkit's module and public package import path is now
|
||||
`go.maximumdirect.net/promptkit`, replacing
|
||||
`gitea.maximumdirect.net/eric/promptkit`. Update application, library, test, and
|
||||
generated imports, then select a release using the new declaration:
|
||||
|
||||
```sh
|
||||
go get go.maximumdirect.net/promptkit@VERSION
|
||||
go mod tidy
|
||||
```
|
||||
|
||||
Replace `VERSION` with a release that declares the vanity module path.
|
||||
Earlier tags, including v0.16.0, retain their original module declaration and
|
||||
use the former import path. No permanent `replace` directive is needed for the
|
||||
cutover. Source browser, licensing, and hosted-release links continue to use
|
||||
the Forge repository URLs, independently of Go's module identifier.
|
||||
|
||||
The package name remains `promptkit`. The path change itself does not rename
|
||||
exported APIs or change their behavior, but Go treats packages imported through
|
||||
the two paths as distinct. Update dependent packages that exchange Promptkit
|
||||
types together and review any old-path dependencies retained after tidying.
|
||||
The configuration and API adaptations below are also part of this migration.
|
||||
|
||||
## Select And Compose The Configuration You Need
|
||||
|
||||
Supply each backend, profile, prompt, schema, and collection source that the
|
||||
|
||||
@@ -12,9 +12,12 @@ file contracts.
|
||||
Import the package as:
|
||||
|
||||
```go
|
||||
import "gitea.maximumdirect.net/eric/promptkit"
|
||||
import "go.maximumdirect.net/promptkit"
|
||||
```
|
||||
|
||||
For migration from the former module path, see
|
||||
[Update Go Imports](configuration-migration.md#update-go-imports).
|
||||
|
||||
Configuration APIs use `go.maximumdirect.net/configkit` v1.0.0. Its types are
|
||||
not interchangeable with the old ConfigKit module path.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user