💻

GoでCLIコマンドを自作して公開するまでの道のり

に公開
Go
OSS
tech

はじめに

Go言語でとあるCLIコマンドを実装し、GitHubで公開しました。

https://github.com/tttol/mergectl

mergectlといいます。mergectlはcurlでバイナリをダウンロードし、/usr/local/bin保存することで利用可能です。
本記事では、GoでCLIコマンドを実装し、公開・配布までの道のりを備忘録的に記載します。

mergectlの機能・開発経緯の説明

本題の前に、mergectlの機能と開発経緯の説明をします。

機能

mergectlは複数のgitブランチを一気にマージするコマンドです。

例えば、下図のようなブランチ構造があったとします。

gitflow

mainブランチからv1ブランチを切り、v1ブランチからv2ブランチを切っているような状態です。
私の業務ではこうした複数バージョンの開発を並行で行うことがあります。

v1にPUSHした変更はv2にも反映しないといけません。
つまり、v1からv2のマージを定期的に実施する必要があります。
v2ブランチでgit merge remotes/origin/v2するだけの単純な作業ですが、日々開発メンバーは多数のコミットをv1，v2にPUSHするのでPUSHのたびに手動でマージするのは大変です。

mergectlでは、gitリポジトリをクローンしたディレクトリでmergectl exec v1 v2と実行するだけで、v1 -> v2へのマージを実施します。

v1tov2

また、hotfixブランチなどでmainブランチに変更が入った場合も、同様にmergectl exec main v1 v2でv1. v2ブランチに変更を反映します。
mergectl exec [source branch] [target branch 1] [target branch 2] [target branch 3] ...
hotfix

開発経緯

mergectlは元々、シェルスクリプトで動かしていたロジックです。以下のシェルスクリプトを日次で定期実行するよう自分のPCに仕込んで運用してました。

# merge main into v1
git checkout v1
git pull
git merge remotes/origin/main --no-ff
git push

# merge v1 into v2
git checkout v2
git pull
git merge remotes/origin/v1 --no-ff
git push

シェルスクリプトでも十分機能していたんですが、開発が進んでバージョンがv3, v4とインクリメントされるたびにブランチ名を変更され、シェルスクリプト内のブランチ名やマージ元ブランチを都度修正する必要がありました。

シェルスクリプトの直接修正は面倒ですし、マージ元・マージ先のブランチを取り違える可能性もありリスクをはらみます。
CLIコマンド化することでこのあたりの辛さを軽減できないかなあと思ったのが、mergectl開発のきっかけでした。

CLIコマンド開発用のライブラリ - Cobra

ここから本題です。

GoでCLIコマンドを実装する方法の一つとしてCobraというライブラリを利用する方法があります。

https://github.com/spf13/cobra

CobraはCLIアプリケーションの実装をサポート・加速するためのライブラリです。
詳しい利用方法はドキュメントを見てください。

CobraはGoで実装されているため、インストールは以下でOKです。かんたん。

go get -u github.com/spf13/cobra@latest

Cobraでは以下のように記述することで、mergectlコマンドを簡単に実装できます。

main.go
func main() {
	cmd.Execute()
}
root.go
package cmd

import (
	"fmt"
	"os"

	"github.com/spf13/cobra"
)

var rootCmd = &cobra.Command{
	Use:   "mergectl",
	Short: "USAGE: mergectl [source branch] [target branch]",
	Long:  `mergectl is a tool of "git merge". This command merge multiple git branches.`,
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("Hello mergectl!")
	},
}

func Execute() {
	if err := rootCmd.Execute(); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}
}

$ mergectl
Hello mergectl!

mergectlを実行すると「Hello mergectl!」と返してくれるCLIコマンドができました。

また、サブコマンドも実装可能です。
以下のようなversion.goを実装することで、mergectl versionを実行するとCLIのバージョンを返してくれるようになります。

version.go
package cmd

import (
	"fmt"

	"github.com/spf13/cobra"
)

var Version string

var versionCmd = &cobra.Command{
	Use:   "version",
	Short: "Print the version number of mergectl",
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("mergectl version:", Version)
	},
}

func init() {
	rootCmd.AddCommand(versionCmd)
}

$ mergectl version
1.0.0-rc

var versionCmdで定義したサブコマンドをrootCmd.AddCommand(versionCmd)でrootに追加するイメージです。
var Version stringにバージョン値をどう代入しているかについては次章で説明します。

アプリバージョンの管理

バージョン値はversion.goのvar Version stringに代入されます。
代入値はビルド時に指定します。コマンドとしては以下です。

go build -ldflags "-X main.version=1.0.0"

main.versionの値はmain.goで宣言したvar versionで受け取ることが可能です。
main.goで受け取ることさえできれば、あとはこの値をversion.goのvar Version stringに引き渡し、よしなに表示させればOKです。

リリース用ライブラリ

リリース方法について説明します。

GoReleaser

作成したCLIコマンドはバイナリファイルで配布します。
バイナリの作成についてはGoReleaserを使います。

https://goreleaser.com/

詳しい利用方法はドキュメントを見てください。

GoReleaserでは.goreleaser.ymlというymlでリリースの設定を管理します。
goreleaser initを実行することでymlが自動生成されます。

私の場合はデフォルトの状態からほとんど修正せず、ほぼそのままymlを利用することができました。
修正した部分は以下です。

.goreleaser.ymlの変更点

builds:
  - ldflags:
      - -s -w
      - -X main.version={{ .Version }}
    # 中略
  flags:
    - -trimpath
  • -ldflags "-X main.version={{ .Version }}"
    • 前述した通り、アプリバージョンを設定するオプション
  • -s
    • デバッグ用の情報を除去する
  • -w
    • デバッグ用の情報を除去する

参考リンク

https://qiita.com/ssc-ynakamura/items/da37856f7f217d708a07

さいごに

今回作ったmergectlはOSSとして公開していますので、ライセンスに沿って自由にご利用ください。

GitHubで編集を提案

Discussion