成人免费xxxxx在线视频软件_久久精品久久久_亚洲国产精品久久久_天天色天天色_亚洲人成一区_欧美一级欧美三级在线观看

云原生小技巧 : 如何自動化發(fā)布 CLI 工具？

作者：Cloud Native 101
云計算 云原生
在自動化構(gòu)建的世界中，編寫一個穩(wěn)定且跨平臺兼容的構(gòu)建腳本是關(guān)鍵。Golang 提供了強大的跨平臺構(gòu)建能力，而 go build 命令是實現(xiàn)這一目標的核心。

在云原生時代，CLI 工具已成為開發(fā)者日常工作中不可或缺的一部分。然而，將開發(fā)好的 CLI 工具分享給大家使用，如果僅依賴手動發(fā)布，不僅效率低，且易出錯，特別是在處理多架構(gòu)和多平臺兼容性時尤為明顯。

那么，我們?nèi)绾尾拍軐崿F(xiàn) CLI 工具的自動化發(fā)布呢？本文旨在探討這一問題，并提出一套實用的解決方案。

在接下來的分享中，我將主要以 Golang 舉例。需要指出的是，我們將討論的自動化構(gòu)建和發(fā)布的原則是通用的，適用于所有編程語言。因此，無論大家使用哪種語言編寫工具，這些實踐都將具有重要的參考價值。

編寫構(gòu)建腳本

在自動化構(gòu)建的世界中，編寫一個穩(wěn)定且跨平臺兼容的構(gòu)建腳本是關(guān)鍵。Golang 提供了強大的跨平臺構(gòu)建能力，而 go build 命令是實現(xiàn)這一目標的核心。例如：

CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -o fooctl-darwin-amd64 -v

這個命令示例突顯了 Golang 在生成特定平臺和架構(gòu)二進制文件方面的靈活性。在構(gòu)建腳本中，我們需要進一步擴展這種靈活性，以支持多平臺構(gòu)建需求。

  1. 參數(shù)化和默認值設(shè)置：

OUTPUT_DIR 和 BINARY_NAME 的設(shè)定允許用戶自定義輸出目錄和二進制文件的名稱，加強了腳本的通用性。

BUILDPATH 變量用于指定構(gòu)建路徑，是腳本運行的必需參數(shù)，保證了構(gòu)建過程的穩(wěn)定性。

  1. 跨平臺和架構(gòu)支持：
  • 通過設(shè)置 BUILD_GOOS 和 BUILD_GOARCH 變量，腳本能夠靈活地處理不同操作系統(tǒng)和架構(gòu)的構(gòu)建需求，增加了適用性。
  • 這些變量的默認值通過 go env 獲取，但也可以通過參數(shù)覆蓋，提供了靈活性。
  1. 動態(tài)輸出路徑：
  • OUT 變量根據(jù)是否為發(fā)布版（IS_RELEASE），動態(tài)調(diào)整輸出文件的命名和路徑。這樣的設(shè)計使得腳本能夠根據(jù)不同的使用場景（如開發(fā)測試或正式發(fā)布）輸出不同格式的文件名。
  1. 特殊情況處理：
  • 對 Windows 平臺的特殊處理（.exe 擴展名）是必要的，因為 Windows 系統(tǒng)下的可執(zhí)行文件通常需要這個擴展名。

gobuild.sh 腳本

下面的 gobuild.sh 腳本是對上述原則的實踐，將跨平臺構(gòu)建的復(fù)雜性轉(zhuǎn)化為簡單的命令行操作：

OUTPUT_DIR=${4:-"bin"}
BINARY_NAME=$(basename ${1})
BUILDPATH=./${1:?"path to build"}

BUILD_GOOS=${GOOS:-$(go env GOOS)}
BUILD_GOARCH=${GOARCH:-$(go env GOARCH)}
GOBINARY=${GOBINARY:-go}
LDFLAGS=$(version::ldflags)

if [ $# -ge 2 ] && [ -n $2 ]; then
  BUILD_GOOS=$2
fi

if [ $# -ge 3 ] && [ -n $3 ]; then
  BUILD_GOARCH=$3
fi

OUT=${OUTPUT_DIR}/${1:?"output path"}
if [ "${IS_RELEASE:-0}" == "1" ]; then
    OUT="${OUTPUT_DIR}/${BINARY_NAME}-${BUILD_GOOS}-${BUILD_GOARCH}"
    if [ "${BUILD_GOOS}" == "windows" ]; then
        OUT="${OUTPUT_DIR}/${BINARY_NAME}-${BUILD_GOOS}-${BUILD_GOARCH}.exe"
    fi
fi

CGO_ENABLED=0 GOOS=${BUILD_GOOS} GOARCH=${BUILD_GOARCH}${GOBINARY} build \
    -ldflags="${LDFLAGS}" \
    -o "${OUT}" \
    "${BUILDPATH}"

這個腳本不僅適應(yīng)了多平臺和多架構(gòu)的需要，還提供了足夠的靈活性和可配置性，以適應(yīng)不同的構(gòu)建場景。

配合 Makefile 實現(xiàn)全自動化構(gòu)建

進一步的，結(jié)合 Makefile 可以將構(gòu)建過程自動化，提升效率：

.PHONY: build-binaries

BUILD_SCRIPT_PATH := ./hack/gobuild/gobuild.sh
# 列出了需要構(gòu)建的所有二進制文件，可管理多個項目的構(gòu)建過程
BINARIES := cmd/fooctl cmd/barctl

# 通過 ALLPLATFORMS 變量，我們定義了一系列目標平臺和架構(gòu)組合
ALLPLATFORMS := linux/amd64 linux/arm64 darwin/amd64 darwin/arm64 windows/amd64 windows/arm64

# 構(gòu)建所有組合
build-binaries: $(foreach bin,$(BINARIES),$(foreach plat,$(ALLPLATFORMS),build-$(bin)-$(plat)))

# 構(gòu)建規(guī)則模板
# 這個模板可以生成特定于每個二進制文件和平臺組合的構(gòu)建規(guī)則。
define BUILD_template
build-$(1)-$(2):
    IS_RELEASE=1 $$(BUILD_SCRIPT_PATH) $(1) $$(subst /, ,$$(word 1,$$(subst -, ,$(2)))) $$(subst /, ,$$(word 2,$$(subst -, ,$(2))))
endef

# 生成構(gòu)建規(guī)則
# 我們自動為每個二進制文件和平臺組合生成了具體的構(gòu)建規(guī)則。
$(foreach bin,$(BINARIES),$(foreach plat,$(ALLPLATFORMS),$(eval $(call BUILD_template,$(bin),$(plat)))))

通過這個 Makefile，即使同時構(gòu)建 fooctl 和 barctl 這兩個 CLI Tool 也變得異常簡單。一條簡單的命令 make build-binaries 就能觸發(fā)整個構(gòu)建流程，大大減少了人工干預(yù)，確保了構(gòu)建過程的一致性和可靠性。

小結(jié)

通過上述詳細的構(gòu)建腳本和 Makefile 配置，我們可以看到，現(xiàn)代軟件開發(fā)中自動化構(gòu)建的強大功能和必要性。這種方法不僅提升了構(gòu)建效率，也增強了軟件的質(zhì)量和穩(wěn)定性。在云原生時代，自動化構(gòu)建已成為提高開發(fā)團隊效率和產(chǎn)品可靠性的關(guān)鍵策略。

Release CLI tool on GitLab CI/CD

在構(gòu)建腳本準備完畢后，接下來我們就可以將其集成到 CI 系統(tǒng)了，下面我以 GitLab CI/CD 為例。

在 GitLab CI/CD 的核心，是一系列定義明確的作業(yè)（Jobs），它們在代碼提交時自動執(zhí)行。對于完整的持續(xù)集成來說，這些作業(yè)通常包括構(gòu)建（build）、測試（test）、代碼審查（lint）等步驟。但在本文中，我們將重點關(guān)注自動發(fā)布流程。

觸發(fā)自動發(fā)布的條件

自動發(fā)布流程是基于 Git 標簽創(chuàng)建的。當(dāng)開發(fā)者推送一個新標簽到倉庫時，GitLab CI/CD 會捕捉到這一事件，并啟動預(yù)定義的發(fā)布流程。

rules:
  - if: $CI_COMMIT_TAG

這個條件確保只有在創(chuàng)建新標簽時，才會啟動后續(xù)的構(gòu)建、上傳和發(fā)布作業(yè)。

Release Jobs

步驟一：構(gòu)建二進制文件，在 build-binaries 階段，CI 會構(gòu)建針對不同平臺和架構(gòu)的 CLI 工具二進制文件，確保構(gòu)建過程的一致性和可重復(fù)性。

步驟二：上傳構(gòu)建產(chǎn)物，待構(gòu)建完成后，upload 階段負責(zé)將二進制文件上傳到 GitLab 的包管理器或其他存儲位置。這為后續(xù)的發(fā)布提供了必要的資源。

步驟三： 發(fā)布到 GitLab，最后，在 release 階段，CI 使用 release-cli 工具自動創(chuàng)建發(fā)布，并將構(gòu)建的二進制文件作為發(fā)布的資產(chǎn)。

Create releases from .gitlab-ci.yml

下面的 .gitlab-ci.yml 腳本是對上述發(fā)布流程的實踐：

stages:
  ...
  - build-binaries
  - upload
  - release
  
build-binaries:
  stage: build-binaries
  image: golang:1.21.1
  rules:
    - if: $CI_COMMIT_TAG
  script:
    - echo "Building binaries for all platforms and architectures..."
    - make build-binaries
  artifacts:
    paths:
      - bin

upload:
  stage: upload
  image: curlimages/curl:latest
  rules:
    - if: $CI_COMMIT_TAG
  script:
    - echo "Uploading binaries..."
    - >
      for binary in ./bin/*; do
        curl --header "JOB-TOKEN: $CI_JOB_TOKEN" \
             --upload-file $binary \
             "${PACKAGE_REGISTRY_URL}/$(basename $binary)";
      done
    
release:
  stage: release
  image: registry.gitlab.com/gitlab-org/release-cli:latest
  rules:
    - if: $CI_COMMIT_TAG
  script:
    - echo "Creating a release for $CI_COMMIT_TAG"
    - |
      ASSET_LINKS=""
      for binary in ./bin/*; do
        LINK="{\"name\":\"$(basename $binary)\", \"url\":\"${PACKAGE_REGISTRY_URL}/$(basename $binary)\"}"
        ASSET_LINKS="${ASSET_LINKS},${LINK}"
      done
      ASSET_LINKS="[${ASSET_LINKS:1}]"
    - >
      release-cli create \
        --name "Release $CI_COMMIT_TAG" \
        --tag-name $CI_COMMIT_TAG \
        --description "Created using the release-cli: $CI_COMMIT_REF_NAME-$CI_JOB_ID" \
        --ref $CI_COMMIT_SHA \
        --assets-link "$ASSET_LINKS"

以上示例將會構(gòu)建 CLI 工具二進制文件，并將其上傳到 Gitlab Release 頁面。用戶從 Gitlab  Release 頁面查找并下載適合其平臺的二進制包即可。

圖片圖片

有關(guān)詳細的 GitLab CI 流程，可以參考項目：https://gitlab.com/lqshow/clireleaseautomator

小結(jié)

這個流程大大簡化了 CLI 工具的發(fā)布過程，使得開發(fā)者能夠?qū)Ｗ⒂诖a開發(fā)，而不是后續(xù)的構(gòu)建和發(fā)布環(huán)節(jié)。自動化這些步驟意味著每次發(fā)布都是快速、一致且無誤的，從而提高了軟件的整體質(zhì)量和可靠性。

Release CLI tool use GoReleaser

不難發(fā)現(xiàn)，上述整個流程相對來說還是比較繁瑣的，準備腳本的過程也比較復(fù)雜，現(xiàn)在我將介紹一個讓這個過程不那么痛苦的工具 GoReleaser[1]。

它是一個變革性的工具，特別是對于以 Golang 編寫的項目。相比于傳統(tǒng)的手動配置和腳本編寫，GoReleaser 提供了一種更高效和簡潔的自動化發(fā)布方法。

GoReleaser 的優(yōu)勢

GoReleaser 的設(shè)計理念是“一次配置，處處運行”，它通過一個單一的配置文件，即可控制整個發(fā)布流程。這個配置文件定義了如何構(gòu)建二進制文件、如何打包它們、如何處理版本信息以及如何發(fā)布到各種平臺。具體來說，GoReleaser 的優(yōu)勢包括：

  1. 簡化的構(gòu)建過程：通過預(yù)定義的模板，GoReleaser 能夠自動構(gòu)建針對不同平臺和架構(gòu)的二進制文件，無需編寫復(fù)雜的腳本。
  2. 靈活的打包和發(fā)布：支持多種格式的打包選項，以及與主要代碼托管平臺的無縫集成。
  3. 高度可配置：從構(gòu)建選項到發(fā)布設(shè)置，GoReleaser 允許高度定制化，以滿足不同項目的需求。

配置和使用 GoReleaser

使用 GoReleaser 的第一步是在項目的根目錄下創(chuàng)建 .goreleaser.yml 配置文件。通過 goreleaser init 命令可快速生成初始配置。這個文件涵蓋了構(gòu)建、打包和發(fā)布的全過程。

在配置好 .goreleaser.yml 之后，我們需要調(diào)整 .gitignore 加上 dist，因為 goreleaser 會默認把編譯編譯好的文件輸出到 dist 目錄中。

接下來我們看個例子：

# .goreleaser.yml 示例
builds:
  - id: fooctl
    binary: fooctl
    main: ./cmd/fooctl
    ldflags:
    - -s -w
    - -X gitlab.com/lqshow/clireleaseautomator-with-goreleaser/version.gitVersinotallow={{.Version}}
    - -X gitlab.com/lqshow/clireleaseautomator-with-goreleaser/version.gitCommit={{.ShortCommit}}
    goos:
      - linux
      - darwin
      - windows
    goarch:
      - amd64
      - arm64
  - id: barctl
    binary: barctl
    main: ./cmd/barctl
    ldflags:
    - -s -w
    - -X gitlab.com/lqshow/clireleaseautomator-with-goreleaser/version.gitVersinotallow={{.Version}}
    - -X gitlab.com/lqshow/clireleaseautomator-with-goreleaser/version.gitCommit={{.ShortCommit}}
    goos:
      - linux
      - darwin
      - windows
    goarch:
      - amd64
      - arm64

這個簡單清晰的配置文件，事實上包含了我之前介紹的兩個模塊，相當(dāng)于省去了寫 shell 腳本和 Makefile 文件，使整個過程更加靈活和高效。

GitLab CI 中的 GoReleaser 集成

在 .gitlab-ci.yml 文件中，我們只需要定義一個簡單的 release 作業(yè)，對了，別忘了還需要在 CI/CD 里配置一個 GTILAB_TOKEN  變量：

stages:
  - release

release:
  stage: release
  image:
    name: goreleaser/goreleaser
    entrypoint: ['']
  only:
    - tags
  variables:
    GIT_DEPTH: 0
    GITLAB_TOKEN: $GITLAB_TOKEN
  script:
    - goreleaserrelease--clean

只要查看運行日志，其實我們就會發(fā)現(xiàn)，GoReleaser 自動執(zhí)行后，它包含了構(gòu)建、上傳和發(fā)布的整個流程。

具體詳情：https://gitlab.com/lqshow/clireleaseautomator-with-goreleaser/-/jobs/5669211977

責(zé)任編輯：武曉燕 來源： Cloud Native 101
CLI工具
相關(guān)推薦

2013-07-23 09:19:53

云服務(wù)器遷移云遷移云遷移工具

2023-11-27 13:41:00

Kubernete本地調(diào)試

2023-02-07 08:11:15

2022-11-24 13:43:40

2024-02-04 09:53:27

2012-06-25 09:35:19

云計算自動化

2022-08-08 07:35:37

云測試工具云存儲云計算

2018-08-27 07:52:03

云計算工具云遷移

2021-06-22 10:31:38

云計算自動化云原生

2019-08-22 09:25:54

云安全云原生Fortinet

2019-10-30 14:47:05

工具代碼開發(fā)

2013-07-02 10:45:38

2020-08-31 22:05:53

Kubernetes微服務(wù)系統(tǒng)

2020-03-10 10:06:08

小程序微信開發(fā)

2012-09-17 13:21:22

iOSAndroid自動化測試工具

2017-11-07 12:33:39

云自動化公有云編排

2020-07-24 09:52:55

自動化ITCIO

2020-02-27 10:11:11

自動化IT安全

2012-10-24 09:40:00

2017-12-17 21:58:18

點贊
收藏

51CTO技術(shù)棧公眾號

主站蜘蛛池模板： 欧美日韩综合精品 | 久久国产精品99久久久久 | 中文字幕国产高清 | 美国十次成人欧美色导视频 | 日本一区二区在线视频 | 成年人免费在线视频 | 国产美女精品视频 | 色在线免费视频 | 成人免费在线观看 | 日韩在线免费电影 | www九色| 久久国产高清 | 色综合色综合色综合 | 丁香久久 | 精品99久久久久久 | 三级免费毛片 | 成人在线视频一区 | 欧美成人精品一区二区男人看 | 欧美午夜一区二区三区免费大片 | 久久久久久精 | 国产一级免费视频 | 日韩中文字幕在线播放 | 精品久久久久香蕉网 | 羞羞视频在线观看免费观看 | www久久av | 精品91久久 | 日韩影院在线观看 | 一区二区精品 | 成人免费在线观看 | 色播视频在线观看 | 亚洲+变态+欧美+另类+精品 | 国产电影一区二区在线观看 | 成人在线中文字幕 | 欧美 日韩 国产 一区 | 国内精品视频 | 欧美中国少妇xxx性高请视频 | 99精品国产一区二区三区 | 亚洲高清视频一区二区 | 国产精品一区二区av | 国产精品日产欧美久久久久 | 国产wwwcom|