如何在Github上發(fā)布自己寫(xiě)的代碼給別人使用

在日常開(kāi)發(fā),我們都會(huì)用到別人寫(xiě)的第三方庫(kù),那么我們也可以把自己寫(xiě)的代碼發(fā)布到github給別人使用

首先要新建一個(gè)人倉(cāng)庫(kù),命名叫g(shù)outil,使用public(私有倉(cāng)庫(kù)不能被別人見(jiàn)到哦!)

然后clone到本地

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

這里我們使用go mod管理go代碼依賴,進(jìn)入到goutil目錄下,執(zhí)行

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

新建文件夾hash,這次我們寫(xiě)個(gè)常見(jiàn)的md5加密函數(shù):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))
}

下面是測(cè)試代碼: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)
    }
}

上面的測(cè)試代碼中的hash是預(yù)先計(jì)算好的(linux環(huán)境下,windows也有類似的命令行工具)

md5sum ./md5.go

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

然后測(cè)試,通過(guò)就可以上傳代碼到遠(yuǎn)程倉(cāng)庫(kù)

接下來(lái)就是git的一些常規(guī)操作:

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

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

待上傳成功后,我們需要發(fā)布下代碼,進(jìn)入到git倉(cāng)庫(kù)goutil,點(diǎn)擊release發(fā)布

創(chuàng)建一個(gè)新的release,版本號(hào)默認(rèn)為v0.0.0的格式,所以第一次發(fā)布我們寫(xiě)v0.1.0,然后添加一些說(shuō)明

發(fā)布成功后,我們可以來(lái)試試自己寫(xiě)的代碼能否被使用:

go get github.com/startdusk/goutil