Migrate ReleaseKit to the vanity module path and new Gitea host
This commit is contained in:
59
docs/releases/v0.5.0.md
Normal file
59
docs/releases/v0.5.0.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# ReleaseKit v0.5.0
|
||||
|
||||
## Summary
|
||||
|
||||
ReleaseKit adopts `go.maximumdirect.net/releasekit` as its Go module identifier.
|
||||
The vanity path resolves to the Gitea repository at
|
||||
`https://forge.maximumdirect.net/base-layer/releasekit`.
|
||||
|
||||
## Changes
|
||||
|
||||
- The orchestration facade is `go.maximumdirect.net/releasekit`, the runtime
|
||||
facade is `go.maximumdirect.net/releasekit/buildinfo`, and the executable
|
||||
package is `go.maximumdirect.net/releasekit/cmd/releasekit`.
|
||||
- Imports, version-injection linkage, compiled API checks, consumer fixtures,
|
||||
and maintained release launchers and Woodpecker workflows use the new module
|
||||
identity.
|
||||
- ReleaseKit's hosted-page delivery profile and maintainer guidance use Gitea
|
||||
at `forge.maximumdirect.net`, owner `base-layer`, repository `releasekit`.
|
||||
|
||||
## Compatibility
|
||||
|
||||
This pre-1.0 minor release changes package import paths and requires consumer
|
||||
migration. Facade roles, command behavior, configuration formats, and the Go
|
||||
1.26.0 consumer minimum retain their existing definitions. The runtime version
|
||||
accessor and builder use the new module's runtime implementation for injection.
|
||||
|
||||
Packages imported through different module paths have distinct Go identities.
|
||||
Coordinate import changes in packages that exchange ReleaseKit facade types,
|
||||
and update builders and applications using `buildinfo` together.
|
||||
|
||||
Published versions through v0.4.2 retain the original
|
||||
`gitea.maximumdirect.net/eric/ReleaseKit` module declaration. Those versions
|
||||
continue to describe their original source and use their matching historical
|
||||
instructions. A vanity-path download of an older tag does not change its module
|
||||
declaration.
|
||||
|
||||
## Upgrade guidance
|
||||
|
||||
1. Update application, library, test, and generated imports for the root facade
|
||||
and `buildinfo` to the new paths. Select v0.5.0 or a later compatible release
|
||||
using the [adoption guide](https://forge.maximumdirect.net/base-layer/releasekit/src/tag/v0.5.0/docs/consumers/adoption.md#migrating-from-the-original-module-path).
|
||||
2. For CLI tool dependencies, remove the old tool declaration and register
|
||||
`go.maximumdirect.net/releasekit/cmd/releasekit` at the selected version.
|
||||
3. Update copied launchers and Woodpecker workflows together with the module
|
||||
selection. The maintained examples use
|
||||
`releasekit_module=go.maximumdirect.net/releasekit`.
|
||||
4. Run `go mod tidy`, review any old-path dependencies retained transitively,
|
||||
and commit module and workflow changes together. Keep existing consumer tags
|
||||
intact; their delivery retries use their recorded module files and matching
|
||||
workflows.
|
||||
|
||||
Source repository and hosted release URLs use the Gitea host; Go imports and
|
||||
tool dependencies use the vanity path. ReleaseKit's source publication and
|
||||
hosted-page delivery retain their separate outcomes under the
|
||||
[maintainer procedure](https://forge.maximumdirect.net/base-layer/releasekit/src/tag/v0.5.0/docs/release.md).
|
||||
|
||||
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/releasekit/src/tag/v0.5.0/COPYRIGHT) |
|
||||
[LICENSE](https://forge.maximumdirect.net/base-layer/releasekit/src/tag/v0.5.0/LICENSE) |
|
||||
[ATTRIBUTION](https://forge.maximumdirect.net/base-layer/releasekit/src/tag/v0.5.0/docs/oss/attribution.md)
|
||||
Reference in New Issue
Block a user