Skip to content

Canonical repo address is inconsistent with module path #3

@KateGo520

Description

@KateGo520

The github.com/KillingSpark/sparkzstd repo used the module, but the module path is set to github.com/killingspark/sparkzstd.
This means that the canonical github repo address now conflicts with canonical go import packages.

It is now very easy for downstream consumers (which used GOPATH mode) to accidentally add imports to upper-case "github.com/KillingSpark/sparkzstd/..." packages. This will create many pitfalls and break the module users. They may encounter errors:

go: downloading github.com/KillingSpark/sparkzstd v0.0.0-20190429053545-8961c737b70e
go: github.com/KillingSpark/sparkzstd upgrade => v0.0.0-20190429053545-8961c737b70e
go get: github.com/KillingSpark/sparkzstd@v0.0.0-20190429053545-8961c737b70e: parsing go.mod:
        module declares its path as: github.com/killingspark/sparkzstd
                but was required as: github.com/KillingSpark/sparkzstd 

Solution

  1. Fix the module path:
    Rename the module path to ”github.com/KillingSpark/sparkzstd”.
    https://github.com/KillingSpark/sparkzstd/blob/master/go.mod#L1
module github.com/KillingSpark/sparkzstd 
  1. Tell the user in the README document to use "github.com/killingspark/sparkzstd" as import path.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions