Skip to content

Rename CLI Go module path to akua-dev #11

Description

@robinbraemer

Why

Public docs should eventually use go install github.com/akua-dev/cli/cmd/cnap@latest, but the akua-dev/cli repository currently declares module github.com/cnap-tech/cli in go.mod. Go rejects the new install path with a module path mismatch, so the docs have to keep the legacy Go module coordinate until the CLI module is migrated.

Compatibility risks

  • GitHub repository redirects do not make Go module paths compatible when go.mod declares a different module path.
  • Existing users may still run go install github.com/cnap-tech/cli/cmd/cnap@latest or pin old versions through the Go module proxy.
  • Tags published before the rename still describe the old module path, so release/tag ordering needs an explicit plan.
  • If any downstream code imports CLI packages, changing module is a breaking import-path change for those consumers.

Required migration steps

  1. Audit akua-dev/cli for github.com/cnap-tech/cli references in go.mod, imports, README, release config, and generated metadata.
  2. Decide the compatibility story for the old module path: keep old tags/repo redirects available, publish a final legacy note, or document the break.
  3. Change go.mod to module github.com/akua-dev/cli and update any internal imports.
  4. Cut a new release tag from the renamed module path.
  5. Verify go install github.com/akua-dev/cli/cmd/cnap@latest in a clean GOPATH/GOMODCACHE.
  6. Update CNAP/Akua public install docs from github.com/cnap-tech/cli to github.com/akua-dev/cli after verification.

Acceptance criteria

  • go install github.com/akua-dev/cli/cmd/cnap@latest succeeds from a clean environment.
  • The old-path compatibility behavior is documented intentionally.
  • Public docs no longer need the github.com/cnap-tech/cli Go install exception.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions