Document Go module migrations for major releases

This commit is contained in:
2026-11-17 19:54:47 +00:00
parent 8551121ef6
commit ea4e82e380

View File

@@ -56,6 +56,24 @@ short summary, relevant compatibility or upgrade instructions, and the required
`COPYRIGHT | LICENSE | ATTRIBUTION` footer with links for the selected version. `COPYRIGHT | LICENSE | ATTRIBUTION` footer with links for the selected version.
Update affected canonical documentation with behavior changes. Update affected canonical documentation with behavior changes.
For a new major release at v2 or later, migrate the Go module path before
committing the candidate:
1. Change the module path in `go.mod` to end in the selected major suffix, such
as `/v4` for v4.0.0.
2. Update imports of Audita packages throughout application and test code to
match that module path. Update module-path references in build configuration
and scripts where applicable.
3. Update current installation examples and release-note upgrade instructions
to use the new module path and version. Preserve historical release notes.
4. Run `go mod tidy` and include the resulting module metadata in the candidate.
For example, the v4.0.0 cutover changes
`gitea.maximumdirect.net/eric/audita/v3` to
`gitea.maximumdirect.net/eric/audita/v4`. The publication command validates the
prepared candidate; module migration is a source change made during preparation.
The normal candidate tests and target builds below validate the migrated source.
End each note with this footer, substituting its complete tag for `<version>`: End each note with this footer, substituting its complete tag for `<version>`:
```markdown ```markdown