@mai0313/go_template 0.1.11

package/README.md

@@ -0,0 +1,90 @@
+<div align="center" markdown="1">
+
+# Go Project Template
+
+[![Go](https://img.shields.io/badge/Go-1.24+-00ADD8?logo=go&logoColor=white)](https://go.dev/dl/)
+[![tests](https://github.com/Mai0313/go_template/actions/workflows/test.yml/badge.svg)](.github/workflows/test.yml)
+[![code-quality](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml/badge.svg)](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![license](https://img.shields.io/badge/License-MIT-green.svg?labelColor=gray)](https://github.com/Mai0313/go_template/tree/master?tab=License-1-ov-file)
+[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Mai0313/go_template/pulls)
+[![contributors](https://img.shields.io/github/contributors/Mai0313/go_template.svg)](https://github.com/Mai0313/go_template/graphs/contributors)
+
+</div>
+
+🚀 A production‑ready Golang project template to bootstrap new Go services and CLIs quickly. It ships with a pragmatic layout, Makefile, Docker builds, and a complete CI/CD suite.
+
+Click [Use this template](../../generate) to start a new repository from this scaffold.
+
+Other Languages: [English](README.md) | [繁體中文](README.zh-TW.md) | [简体中文](README.zh-CN.md)
+
+## ✨ Highlights
+
+- Makefile tasks: build, test, cross‑compile, format, dead‑code scan
+- Version embedding via `-ldflags` (version, build time, git commit)
+- Example CLI under `cmd/go_template` with `--version`
+- Unit tests with coverage artifact in CI
+- Docker: multi‑stage image build with cache and minimal runtime
+- GitHub Actions: test, lint (golangci‑lint), image build+push, release drafter, labels, secret/code scanning
+
+## 🚀 Quick Start
+
+Prerequisites:
+
+- Go 1.24+
+- Docker (optional, for container builds)
+
+Local setup:
+
+```bash
+make build            # build binaries into ./build/
+make run              # build and run the main command
+make test             # run unit tests with coverage
+make fmt              # format code (go fmt ./...)
+make build-all        # cross‑compile common OS/ARCH targets
+```
+
+Run the example CLI:
+
+```bash
+./build/go_template --version
+```
+
+Use as a template:
+
+1. Click Use this template to create your repository
+2. Replace module name in `go.mod` as needed
+3. Rename the command under `cmd/` if you want a different binary name
+
+## Project Structure
+
+```text
+cmd/go_template/     # Main CLI entrypoint
+core/version/        # Version utilities and tests
+build/               # Build outputs (git‑ignored)
+docker/Dockerfile    # Multi‑stage image build
+```
+
+## Docker
+
+```bash
+# Build & run image locally
+docker build -t your/image:dev -f docker/Dockerfile .
+docker run --rm -it your/image:dev
+```
+
+## CI/CD (GitHub Actions)
+
+- tests: `.github/workflows/test.yml`
+- quality: `.github/workflows/code-quality-check.yml`
+- release package: `.github/workflows/build_release.yml`
+- docker image: `.github/workflows/build_image.yml`
+- release drafter: `.github/workflows/release_drafter.yml`
+- labels & semantics: `.github/workflows/auto_labeler.yml`, `semantic-pull-request.yml`
+- security: `.github/workflows/code_scan.yml` (gitleaks, trivy, codeql)
+
+## Contribution
+
+- Run `make fmt && make test` before pushing
+- Keep PRs focused and small; include tests
+- Use Conventional Commit messages

package/README.zh-CN.md

@@ -0,0 +1,90 @@
+<div align="center" markdown="1">
+
+# Go 项目模板
+
+[![Go](https://img.shields.io/badge/Go-1.24+-00ADD8?logo=go&logoColor=white)](https://go.dev/dl/)
+[![tests](https://github.com/Mai0313/go_template/actions/workflows/test.yml/badge.svg)](.github/workflows/test.yml)
+[![code-quality](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml/badge.svg)](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![license](https://img.shields.io/badge/License-MIT-green.svg?labelColor=gray)](https://github.com/Mai0313/go_template/tree/master?tab=License-1-ov-file)
+[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Mai0313/go_template/pulls)
+[![contributors](https://img.shields.io/github/contributors/Mai0313/go_template.svg)](https://github.com/Mai0313/go_template/graphs/contributors)
+
+</div>
+
+🚀 面向 Golang 的生产级项目模板，帮助你快速创建新的 Go 服务或 CLI。内置合理的目录结构、Makefile、Docker 多阶段构建，以及完整的 CI/CD 工作流。
+
+点击 [使用此模板](../../generate) 开始。
+
+其他语言: [English](README.md) | [繁體中文](README.zh-TW.md) | [简体中文](README.zh-CN.md)
+
+## ✨ 特性
+
+- Makefile 任务：build、test、交叉编译、fmt、dead‑code 扫描
+- 版本信息嵌入：通过 `-ldflags` 注入 version、build time、git commit
+- 示例 CLI：`cmd/go_template` 支持 `--version`
+- 单元测试，CI 上传覆盖率 HTML 产物
+- Docker：多阶段构建，最小化运行时镜像
+- GitHub Actions：测试、静态检查（golangci‑lint）、镜像构建/推送、Release Drafter、标签、机密/代码扫描
+
+## 🚀 快速开始
+
+前置条件：
+
+- Go 1.24+
+- Docker（可选，用于容器构建）
+
+本地开发：
+
+```bash
+make build            # 编译到 ./build/
+make run              # 编译并运行主命令
+make test             # 运行单元测试并生成覆盖率
+make fmt              # go fmt ./...
+make build-all        # 交叉编译常见 OS/ARCH
+```
+
+运行示例 CLI：
+
+```bash
+./build/go_template --version
+```
+
+作为模板使用：
+
+1. 点击“使用此模板”创建你的仓库
+2. 按需修改 `go.mod` 的 module 名称
+3. 若需更换二进制名称，调整 `cmd/` 目录结构
+
+## 项目结构
+
+```text
+cmd/go_template/     # 主 CLI 入口
+core/version/        # 版本工具与测试
+build/               # 编译输出（已被 .gitignore 忽略）
+docker/Dockerfile    # 多阶段镜像构建
+```
+
+## Docker
+
+```bash
+# 本地构建与运行
+docker build -t your/image:dev -f docker/Dockerfile .
+docker run --rm -it your/image:dev
+```
+
+## CI/CD（GitHub Actions）
+
+- 测试：`.github/workflows/test.yml`
+- 质量：`.github/workflows/code-quality-check.yml`
+- 发布打包：`.github/workflows/build_release.yml`
+- Docker 镜像：`.github/workflows/build_image.yml`
+- 发布草稿：`.github/workflows/release_drafter.yml`
+- 标签与语义化：`.github/workflows/auto_labeler.yml`, `semantic-pull-request.yml`
+- 安全：`.github/workflows/code_scan.yml`（gitleaks、trivy、codeql）
+
+## 贡献指南
+
+- 提交前执行 `make fmt && make test`
+- PR 聚焦单一变更并附带测试
+- 使用 Conventional Commits 提交信息

package/README.zh-TW.md

@@ -0,0 +1,90 @@
+<div align="center" markdown="1">
+
+# Go 專案模板
+
+[![Go](https://img.shields.io/badge/Go-1.24+-00ADD8?logo=go&logoColor=white)](https://go.dev/dl/)
+[![tests](https://github.com/Mai0313/go_template/actions/workflows/test.yml/badge.svg)](.github/workflows/test.yml)
+[![code-quality](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml/badge.svg)](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![license](https://img.shields.io/badge/License-MIT-green.svg?labelColor=gray)](https://github.com/Mai0313/go_template/tree/master?tab=License-1-ov-file)
+[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Mai0313/go_template/pulls)
+[![contributors](https://img.shields.io/github/contributors/Mai0313/go_template.svg)](https://github.com/Mai0313/go_template/graphs/contributors)
+
+</div>
+
+🚀 幫助 Golang 開發者「快速建立新專案」的模板。提供務實的專案結構、Makefile、Docker 多階段建置，以及完整的 GitHub Actions 工作流程。
+
+點擊 [使用此模板](../../generate) 後即可開始。
+
+其他語言: [English](README.md) | [繁體中文](README.zh-TW.md) | [简体中文](README.zh-CN.md)
+
+## ✨ 重點特色
+
+- Makefile 工作流：build、test、跨平台編譯、fmt、dead‑code 掃描
+- 內建版本資訊：以 `-ldflags` 注入 version、build time、git commit
+- 範例 CLI：`cmd/go_template`，支援 `--version`
+- 單元測試與 CI 覆蓋率報告產物
+- Docker：多階段建置，最小化執行環境
+- GitHub Actions：測試、靜態檢查（golangci‑lint）、映像建置/推送、Release Drafter、標籤、自動秘密/程式碼掃描
+
+## 🚀 快速開始
+
+需求：
+
+- Go 1.24+
+- Docker（可選，用於容器化建置）
+
+本機開發：
+
+```bash
+make build            # 編譯到 ./build/
+make run              # 編譯並執行主程式
+make test             # 執行測試並輸出覆蓋率
+make fmt              # go fmt ./...
+make build-all        # 跨平台編譯常見 OS/ARCH
+```
+
+執行範例 CLI：
+
+```bash
+./build/go_template --version
+```
+
+作為模板使用：
+
+1. 點擊「使用此模板」建立你的倉庫
+2. 視需求修改 `go.mod` 的 module 名稱
+3. 若要更換二進位名稱，請調整 `cmd/` 目錄結構
+
+## 專案結構
+
+```text
+cmd/go_template/     # 主 CLI 入口
+core/version/        # 版本工具與測試
+build/               # 編譯輸出（已加入 .gitignore）
+docker/Dockerfile    # 多階段映像建置
+```
+
+## Docker
+
+```bash
+# 本地建置與執行
+docker build -t your/image:dev -f docker/Dockerfile .
+docker run --rm -it your/image:dev
+```
+
+## CI/CD（GitHub Actions）
+
+- 測試：`.github/workflows/test.yml`
+- 品質：`.github/workflows/code-quality-check.yml`
+- 釋出打包：`.github/workflows/build_release.yml`
+- Docker 映像：`.github/workflows/build_image.yml`
+- 釋出草稿：`.github/workflows/release_drafter.yml`
+- 標籤與語義化：`.github/workflows/auto_labeler.yml`, `semantic-pull-request.yml`
+- 安全性：`.github/workflows/code_scan.yml`（gitleaks、trivy、codeql）
+
+## 貢獻指南
+
+- 提交前請執行 `make fmt && make test`
+- PR 請聚焦單一變更並附上測試
+- 使用 Conventional Commits 作為提交訊息

package/bin/start.js

@@ -0,0 +1,90 @@
+#!/usr/bin/env node
+
+const { spawn } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+
+// Determine platform-specific directory and binary name
+function getPlatformInfo() {
+  const platform = process.platform;
+  const arch = process.arch;
+
+  const platformMap = {
+    darwin: {
+      x64: { dir: 'macos-x64', binary: 'go_template' },
+      arm64: { dir: 'macos-arm64', binary: 'go_template' },
+    },
+    linux: {
+      x64: { dir: 'linux-x64-gnu', binary: 'go_template' },
+      arm64: { dir: 'linux-arm64-gnu', binary: 'go_template' },
+    },
+    win32: {
+      x64: { dir: 'windows-x64', binary: 'go_template.exe' },
+      arm64: { dir: 'windows-arm64', binary: 'go_template.exe' },
+    },
+  };
+
+  if (!platformMap[platform] || !platformMap[platform][arch]) {
+    console.error(`Unsupported platform: ${platform}-${arch}`);
+    process.exit(1);
+  }
+
+  return platformMap[platform][arch];
+}
+
+// Find the binary for current platform
+function findBinary() {
+  const platformInfo = getPlatformInfo();
+  const packageRoot = path.join(__dirname, '..');
+  const binariesDir = path.join(packageRoot, 'binaries');
+
+  if (!fs.existsSync(binariesDir)) {
+    console.error('Error: Binaries directory not found.');
+    console.error('Please reinstall the package.');
+    process.exit(1);
+  }
+
+  // Look for the binary in platform-specific subdirectory
+  const platformDir = path.join(binariesDir, platformInfo.dir);
+  const binaryPath = path.join(platformDir, platformInfo.binary);
+
+  if (!fs.existsSync(binaryPath)) {
+    console.error(`Error: Binary not found for your platform: ${platformInfo.dir}/${platformInfo.binary}`);
+    console.error('Please reinstall the package.');
+    process.exit(1);
+  }
+
+  // Make binary executable on Unix-like systems
+  if (process.platform !== 'win32') {
+    try {
+      fs.chmodSync(binaryPath, 0o755);
+    } catch (err) {
+      // Ignore error if already executable
+    }
+  }
+
+  return binaryPath;
+}
+
+// Get binary path
+const binaryPath = findBinary();
+
+// Forward all arguments to the binary
+const args = process.argv.slice(2);
+const child = spawn(binaryPath, args, {
+  stdio: 'inherit',
+  windowsHide: true,
+});
+
+child.on('exit', (code, signal) => {
+  if (signal) {
+    process.kill(process.pid, signal);
+  } else {
+    process.exit(code);
+  }
+});
+
+child.on('error', (err) => {
+  console.error('Failed to start binary:', err);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@mai0313/go_template",
+  "version": "0.1.11",
+  "description": "A production-ready Go project template to bootstrap new projects fast. It includes a clean Go module layout, Docker, and a complete CI/CD suite.",
+  "author": "Wei Lee <mai@mai0313.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/Mai0313/go_template",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Mai0313/go_template.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Mai0313/go_template/issues"
+  },
+  "keywords": [
+    "cli",
+    "go",
+    "golang",
+    "template",
+    "go-template",
+    "boilerplate",
+    "starter-kit"
+  ],
+  "bin": {
+    "go_template": "bin/start.js",
+    "gotemp": "bin/start.js"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "files": [
+    "bin/",
+    "binaries/",
+    "README.md"
+  ]
+}