Merge pull request #898 from rackerlabs/understack-cli-release

feat: add understack cli release.

Author: cardoe

.github/workflows/understackctl-release.yaml

@@ -0,0 +1,48 @@
+name: Releases
+on:
+  push:
+    tags:
+      - "understackctl/v[0-9]+.[0-9]+.[0-9]+"
+
+permissions:
+  contents: write
+  packages: write
+  id-token: write
+  issues: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+      id-token: write
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4
+        with:
+          fetch-depth: 1
+
+      - name: Setup Go
+        uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.1
+        with:
+          go-version: stable
+          cache: true
+
+      - name: Install dependencies
+        run: sudo apt-get install -y sed grep
+
+      - name: Build and Package
+        working-directory: go/understackctl
+        run: |
+          make build-all package-all checksums
+
+      - name: Upload release artifacts
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            go/understackctl/build/*.zip
+            go/understackctl/build/*.tar.gz
+            go/understackctl/build/checksums.txt
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

go/understackctl/.gitignore

@@ -21,6 +21,7 @@ vendor/
 
 # goreleaser dist folder
 dist/
+build/
 
 # IntelliJ
 .idea

go/understackctl/Makefile

@@ -0,0 +1,85 @@
+# Makefile will understackctl go binary for multiple GOOS and GOARCH
+#
+# Output will be like this:
+# understackctl_darwin_amd64/
+#   └── understackctl
+# understackctl_windows_amd64/
+#   └── understackctl.exe
+# understackctl_darwin_amd64.tar.gz
+# understackctl_windows_amd64.zip
+#
+# package-all: will package folders into .tar.gz and for windows .zip
+
+BINARY_NAME=understackctl
+
+GOOS_LIST=linux darwin windows
+GOARCH_LIST=386 amd64 arm64
+
+BUILD_DIR=build
+
+VERSION := $(shell git describe --tags --abbrev=0 --match "understackctl/v[0-9]*.[0-9]*.[0-9]*" 2>/dev/null || echo "dev")
+COMMIT  := $(shell git rev-parse --short HEAD)
+LDFLAGS := -ldflags="-s -w -X 'main.version=$(VERSION)' -X 'main.commit=$(COMMIT)'"
+
+.PHONY: all
+all: build build-all package-all
+
+.PHONY: build
+build:
+	@echo "Building for current OS/Arch..."
+	@mkdir -p $(BUILD_DIR)/$(BINARY_NAME)
+	CGO_ENABLED=0 GOOS=$(shell go env GOOS) GOARCH=$(shell go env GOARCH) go build $(LDFLAGS) -o $(BUILD_DIR)/$(BINARY_NAME)/$(BINARY_NAME) .
+
+.PHONY: build-all
+build-all:
+	@mkdir -p $(BUILD_DIR)
+	@for GOOS in $(GOOS_LIST); do \
+		for GOARCH in $(GOARCH_LIST); do \
+			if [ "$$GOOS" = "darwin" ] && [ "$$GOARCH" = "386" ]; then \
+				continue; \
+			fi; \
+			DIR=$(BUILD_DIR)/$(BINARY_NAME)_$$GOOS\_$$GOARCH; \
+			EXT=$$([ "$$GOOS" = "windows" ] && echo ".exe" || echo ""); \
+			OUTFILE=$$DIR/$(BINARY_NAME)$$EXT; \
+			mkdir -p $$DIR; \
+			echo "Building $$OUTFILE..."; \
+			CGO_ENABLED=0 GOOS=$$GOOS GOARCH=$$GOARCH go build $() -o $$OUTFILE . || echo "Failed to build $$GOOS/$$GOARCH"; \
+		done \
+	done
+
+# Loops over all the dirs in build/ folder
+# for windows build zip
+# else use .tar.gz
+.PHONY: package-all
+package-all:
+	@echo "Packaging builds..."
+	@cd $(BUILD_DIR) && for d in $(BINARY_NAME)_*; do \
+		if echo $$d | grep -q "windows"; then \
+			zip -qr "$$d.zip" "$$d"; \
+		else \
+			tar -czf "$$d.tar.gz" "$$d"; \
+		fi \
+	done
+
+
+# Loops over *.zip and *.tar.gz in build/
+# Uses sha256sum if available (Linux)
+# Falls back to shasum -a 256 on macOS
+# Outputs clean filenames without ./
+# Result is stored in build/checksums.txt
+.PHONY: checksums
+checksums:
+	@echo "Generating checksums..."
+	@cd $(BUILD_DIR) && \
+	for f in *.zip *.tar.gz; do \
+		if command -v sha256sum >/dev/null 2>&1; then \
+			sha256sum "$$f"; \
+		else \
+			shasum -a 256 "$$f"; \
+		fi; \
+	done | sort > checksums.txt
+
+# remove build dir
+.PHONY: clean
+clean:
+	rm -rf $(BUILD_DIR)

go/understackctl/README.md

@@ -1,6 +1,6 @@
-# understack
+# understackctl
 
-UnderStack CLI helps quickly generate a deployment repository.
+understackctl is a CLI that helps quickly generate a deployment repository.
 
 ## How to use
 
@@ -18,7 +18,7 @@ export UC_DEPLOY_EMAIL="<your_email>"
 export UC_AIO=yes
 ```
 
-* Run
+* Quick Run
 
 ```
 go run *.go quickstart
@@ -27,6 +27,33 @@ go run *.go help
 
 * Commit all changes to the undercloud-deploy repo in your branch
 
+## Build
+
+* Local build `make build` ( this will only build binary for you local os ).
+* Cross-Platform build `make build-all` ( build for linux-mac-windows )
+
+## Development
+
+* To add a new command, create a function like this.
+
+```go
+func NewCmdMyCommand() *cobra.Command {
+	return &cobra.Command{
+		Use:   "mycommand",
+		Short: "This will run my command",
+		Long:  "This will run my command",
+		Run:   myCommandFunction,
+	}
+}
+```
+
+* After that register it to `cmd/root/root.go`
+
+```go
+func init() {
+	rootCmd.AddCommand(deploy.NewCmdMyCommand())
+}
+```
 
 ## Contributing