如何在Github上發布自己寫的代碼給別人使用

在日常開發,我們都會用到別人寫的第三方庫,那么我們也可以把自己寫的代碼發布到github給別人使用

首先要新建一個人倉庫,命名叫goutil,使用public(私有倉庫不能被別人見到哦!)

然后clone到本地

git clone https://github.com/startdusk/goutil.git

這里我們使用go mod管理go代碼依賴,進入到goutil目錄下,執行

go mod init github.com/startdusk/goutil   # 使用和github.com上的路徑做包名

新建文件夾hash,這次我們寫個常見的md5加密函數:goutil/hash/md5.go

package hash
?
import (
    "crypto/md5"
    "encoding/hex"
    "errors"
    "fmt"
    "io"
    "os"
)
?
// get file md5
func FileMd5(filename string) (string, error) {
    file, err := os.Open(filename)
    if err != nil {
    return "", errors.New(
        fmt.Sprintf("md5.go hash.FileMd5 os open error %v", err))
    }
    h := md5.New()
    _, err = io.Copy(h, file)
    if err != nil {
        return "", errors.New(fmt.Sprintf("md5.go hash.FileMd5 io copy error %v", err))
    }
?
    return hex.EncodeToString(h.Sum(nil)), nil
}
?
// get string md5
func StringMd5(s string) string {
    md5 := md5.New()
    md5.Write([]byte(s))
    return hex.EncodeToString(md5.Sum(nil))
}

下面是測試代碼:goutil/hash/md5_test.go

package hash
?
import "testing"
?
func TestMd5(t *testing.T) {
    const expectFileMd5 = "7861252f1d3f3bc4e377782deb212dca"
    actualFileMd5, err := FileMd5("./md5.go")
    if err != nil {
        panic(err)
    }
?
    if expectFileMd5 != actualFileMd5 {
        t.Errorf("expect file md5 is %s; but had %s\n", expectFileMd5, actualFileMd5)
    }
?
    const str = "why did you like golang"
    const expectStringMd5 = "09a6f16fc1e802003b4c0c11b69761d2"
    actualStringMd5 := StringMd5(str)
    if expectStringMd5 != actualStringMd5 {
        t.Errorf("expect string md5 value is %s; but had %s\n", expectStringMd5, actualStringMd5)
    }
}
?
func BenchmarkMd5(b *testing.B) {
    for i := 0; i < b.N; i++ {
        _, err := FileMd5("./md5.go")
        if err != nil {
            panic(err)
        }
    }
?
    const str = "why did you like golang"
    for i := 0; i < b.N; i++ {
        _ = StringMd5(str)
    }
}

上面的測試代碼中的hash是預先計算好的(linux環境下,windows也有類似的命令行工具)

md5sum ./md5.go

echo -n "why did you like golang" | md5sum

然后測試,通過就可以上傳代碼到遠程倉庫

接下來就是git的一些常規操作:

git add .
git commit -m "Add a md5 functions"
git push

如果需要過濾掉一些不想上傳的文件,在.gitignore上添加

待上傳成功后,我們需要發布下代碼,進入到git倉庫goutil,點擊release發布

創建一個新的release,版本號默認為v0.0.0的格式,所以第一次發布我們寫v0.1.0,然后添加一些說明

發布成功后,我們可以來試試自己寫的代碼能否被使用:

go get github.com/startdusk/goutil