Golang項目在github創(chuàng)建release后自動生成二進制文件的方法

更新時間：2023年03月18日 10:20:41 作者：路多辛

這篇文章主要介紹了Golang項目在github創(chuàng)建release后如何自動生成二進制文件,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

希望達(dá)到的效果

工具類的Golang項目需要編譯成二進制文件后在命令行中運行，所以希望在github里面創(chuàng)建一個新的release后能自動編譯成針對各個平臺的二進制文件，如下圖所示：

實現(xiàn)方式

借助 GoReleaser 這款工具配合 github actions 可以很方便實現(xiàn)這種效果，下面講解下具體實現(xiàn)方法。

首先需要在 Golang 項目的根目錄創(chuàng)建 GoReleaser 配置文件 .goreleaser.yaml，內(nèi)容如下：

# This is an example .goreleaser.yml file with some sensible defaults.
# Make sure to check the documentation at https://goreleaser.com
before:
  hooks:
    # You may remove this if you don't use go modules.
    - go mod tidy
    # you may remove this if you don't need go generate
    - go generate ./...
builds:
  - env:
      - CGO_ENABLED=0
    goos:
      - linux
      - windows
      - darwin
 
archives:
  - format: tar.gz
    # this name template makes the OS and Arch compatible with the results of uname.
    name_template: >-
      {{ .ProjectName }}_
      {{- title .Os }}_
      {{- if eq .Arch "amd64" }}x86_64
      {{- else if eq .Arch "386" }}i386
      {{- else }}{{ .Arch }}{{ end }}
      {{- if .Arm }}v{{ .Arm }}{{ end }}
    # use zip for windows archives
    format_overrides:
    - goos: windows
      format: zip
checksum:
  name_template: 'checksums.txt'
snapshot:
  name_template: "{{ incpatch .Version }}-next"
changelog:
  sort: asc
  filters:
    exclude:
      - '^docs:'
      - '^test:'
 
# The lines beneath this are called `modelines`. See `:help modeline`
# Feel free to remove those if you don't want/use them.
# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
# vim: set ts=2 sw=2 tw=0 fo=cnqoj

然后創(chuàng)建 github actions 配置文件，在Golang項目的根目錄創(chuàng)建 .github 文件夾，在這個文件夾里面創(chuàng)建 workflows 文件夾，在 workflows 文件夾里面創(chuàng)建 release.yaml 文件，內(nèi)容如下：

name: goreleaser
 
on:
  push:
    # run only against tags
    tags:
      - '*'
 
permissions:
  contents: write
  # packages: write
  # issues: write
 
jobs:
  goreleaser:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - run: git fetch --force --tags
      - uses: actions/setup-go@v3
        with:
          go-version: '>=1.20.2'
          cache: true
      # More assembly might be required: Docker logins, GPG, etc. It all depends
      # on your needs.
      - uses: goreleaser/goreleaser-action@v4
        with:
          # either 'goreleaser' (default) or 'goreleaser-pro':
          distribution: goreleaser
          version: latest
          args: release --clean
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          # Your GoReleaser Pro key, if you are using the 'goreleaser-pro'
          # distribution:
          # GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}

這個文件的內(nèi)容不需要做任何修改，提交代碼并將代碼 push 到 github 后，在 github 的 release 頁面新建一個 release 后，在 Actions 頁面就可以看到有一個workflow在運行：