5af107b06d
- GitHub release support: internal/ghclient (no SDK, minimal HTTP client); GITHUB_TOKEN env var; github.token/github.repo config; GitHub takes precedence over GitLab when both are configured; publisher interface (releasePublisher) in cmd/main.go makes providers interchangeable - SSH agent push: gitutil.Push() now tries gitssh.NewSSHAgentAuth for git@/ssh:// remotes before falling back to the system git binary - --release-env-file flag: override dotenv artifact path; pass "" to disable - git.releasable_types config: filter which commit types trigger a bump (defaults to fix, feat, breaking); useful for maintenance branches - commits.Group(), ExtractSubject(), ReleasableSet() exported helpers: notes.go and changelog.go now delegate to these instead of duplicating - CHANGELOG deduplication guard: changelog.Update() is idempotent — skips write if ## [version] section already exists - Always load config sources: LoadWithSources() called unconditionally; removes the dual config path that previously only tracked sources in --verbose mode - .releaser.gitlab-ci.yml: adds artifacts: reports: dotenv: release.env Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
534 lines
16 KiB
Go
534 lines
16 KiB
Go
package main
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
gogit "github.com/go-git/go-git/v5"
|
|
"github.com/spf13/cobra"
|
|
|
|
"git.k3nny.fr/releaser/internal/branch"
|
|
"git.k3nny.fr/releaser/internal/changelog"
|
|
"git.k3nny.fr/releaser/internal/commits"
|
|
"git.k3nny.fr/releaser/internal/config"
|
|
"git.k3nny.fr/releaser/internal/ghclient"
|
|
"git.k3nny.fr/releaser/internal/gitutil"
|
|
"git.k3nny.fr/releaser/internal/glclient"
|
|
"git.k3nny.fr/releaser/internal/maven"
|
|
"git.k3nny.fr/releaser/internal/notes"
|
|
semver "git.k3nny.fr/releaser/internal/version"
|
|
)
|
|
|
|
const defaultConfigTemplate = `# .releaser.yml — configuration for git.k3nny.fr/releaser
|
|
# All fields are optional. Uncomment and adjust what you need.
|
|
# CLI flags always take precedence over values set here.
|
|
|
|
git:
|
|
# Prefix prepended to every version tag (default: no prefix).
|
|
# tag_prefix: "v"
|
|
|
|
# Regex that identifies release branches. Must contain exactly two capture
|
|
# groups: group 1 = major version, group 2 = minor version.
|
|
# branch_pattern: "^(?:.*/)?release/(\\d+)\\.(\\d+)$"
|
|
|
|
# Template for the version-bump commit message.
|
|
# {version} is replaced with the full tag name (e.g. "v1.2.3").
|
|
# commit_message: "chore(release): {version} [skip ci]"
|
|
|
|
# Override the git commit author. When omitted, releaser reads user.name
|
|
# and user.email from the repository's git config.
|
|
# author_name: ""
|
|
# author_email: ""
|
|
|
|
# Limit which commit types trigger a release (default: fix, feat, breaking).
|
|
# releasable_types:
|
|
# - fix
|
|
# - feat
|
|
# - breaking
|
|
|
|
maven:
|
|
# Path to pom.xml, relative to the repository root.
|
|
# pom_path: "pom.xml"
|
|
|
|
gitlab:
|
|
# GitLab instance URL. Falls back to the CI_SERVER_URL environment variable.
|
|
# url: "https://gitlab.example.com"
|
|
|
|
# Personal or CI access token with api scope.
|
|
# Falls back to the GITLAB_TOKEN environment variable.
|
|
# Tip: never commit a real token here — use the environment variable instead.
|
|
# token: ""
|
|
|
|
# Numeric project ID or "namespace/project" path.
|
|
# Falls back to CI_PROJECT_ID, then CI_PROJECT_PATH environment variables.
|
|
# project: ""
|
|
|
|
github:
|
|
# GitHub personal access token with repo scope.
|
|
# Falls back to the GITHUB_TOKEN environment variable.
|
|
# token: ""
|
|
|
|
# Repository in "owner/repo" format.
|
|
# repo: ""
|
|
`
|
|
|
|
var (
|
|
version = "dev" // overridden at build time via -ldflags "-X main.version=..."
|
|
errNothingToRelease = errors.New("nothing to release")
|
|
)
|
|
|
|
// exitFn is a variable so tests can intercept os.Exit calls.
|
|
var exitFn = os.Exit
|
|
|
|
// releasePublisher is implemented by both glclient and ghclient.
|
|
type releasePublisher interface {
|
|
CreateRelease(ctx context.Context, tagName, body string) error
|
|
}
|
|
|
|
// buildPublisher selects and returns the active release publisher based on config.
|
|
// GitHub takes precedence over GitLab when both are configured.
|
|
// Returns (nil, nil) when no provider is configured — caller should skip release creation.
|
|
func buildPublisher(cfg config.Config) (releasePublisher, error) {
|
|
if cfg.GitHub.Token != "" && cfg.GitHub.Repo != "" {
|
|
return ghclient.New(cfg.GitHub.Token, cfg.GitHub.Repo), nil
|
|
}
|
|
if cfg.GitLab.URL != "" && cfg.GitLab.Project != "" {
|
|
if cfg.GitLab.Token == "" {
|
|
return nil, fmt.Errorf("GITLAB_TOKEN not set — required for release creation")
|
|
}
|
|
return glclient.New(cfg.GitLab.URL, cfg.GitLab.Token, cfg.GitLab.Project), nil
|
|
}
|
|
return nil, nil
|
|
}
|
|
|
|
func newRootCmd() *cobra.Command {
|
|
var (
|
|
init_ bool
|
|
verbose bool
|
|
dryRun bool
|
|
noPush bool
|
|
noRelease bool
|
|
noCommit bool
|
|
tagOnly bool
|
|
branchOverride string
|
|
repoPath string
|
|
pomOverride string
|
|
changelogFile string
|
|
tagPrefixFlag string
|
|
tagPrefixSet bool
|
|
patternFlag string
|
|
patternSet bool
|
|
releaseEnvFile string
|
|
)
|
|
|
|
root := &cobra.Command{
|
|
Use: "releaser",
|
|
Short: "GitFlow release automation for Conventional Commits",
|
|
Version: version,
|
|
SilenceUsage: true,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
tagPrefixSet = cmd.Flags().Changed("tag-prefix")
|
|
patternSet = cmd.Flags().Changed("branch-pattern")
|
|
return run(options{
|
|
init: init_,
|
|
verbose: verbose,
|
|
repoPath: repoPath,
|
|
branchOverride: branchOverride,
|
|
pomOverride: pomOverride,
|
|
changelogFile: changelogFile,
|
|
tagPrefixFlag: tagPrefixFlag,
|
|
tagPrefixSet: tagPrefixSet,
|
|
patternFlag: patternFlag,
|
|
patternSet: patternSet,
|
|
dryRun: dryRun,
|
|
noPush: noPush,
|
|
noRelease: noRelease,
|
|
noCommit: noCommit,
|
|
tagOnly: tagOnly,
|
|
releaseEnvFile: releaseEnvFile,
|
|
})
|
|
},
|
|
}
|
|
|
|
root.Flags().BoolVar(&init_, "init", false, "create a default .releaser.yml in the repository and exit")
|
|
root.Flags().BoolVar(&verbose, "verbose", false, "print configuration sources, commit list, and version decision")
|
|
root.Flags().BoolVar(&dryRun, "dry-run", false, "print next version without making changes")
|
|
root.Flags().BoolVar(&noPush, "no-push", false, "create commit and tag locally without pushing or creating a release")
|
|
root.Flags().BoolVar(&noRelease, "no-release", false, "push commit and tag but skip creating the release")
|
|
root.Flags().BoolVar(&noCommit, "no-commit", false, "update files but do not commit, tag, or push")
|
|
root.Flags().BoolVar(&tagOnly, "tag-only", false, "tag HEAD without updating files (assumes version was already committed)")
|
|
root.Flags().StringVar(&branchOverride, "branch", "", "override branch name detection (required in detached HEAD)")
|
|
root.Flags().StringVar(&repoPath, "repo", ".", "path to git repository")
|
|
root.Flags().StringVar(&pomOverride, "pom", "", "override maven.pom_path from config")
|
|
root.Flags().StringVar(&changelogFile, "changelog-file", "CHANGELOG.md", "path to changelog file relative to repo root")
|
|
root.Flags().StringVar(&tagPrefixFlag, "tag-prefix", "", "override git.tag_prefix from config")
|
|
root.Flags().StringVar(&patternFlag, "branch-pattern", "", "override git.branch_pattern from config")
|
|
root.Flags().StringVar(&releaseEnvFile, "release-env-file", "release.env", "write NEXT_VERSION dotenv to this path (relative to repo root; empty to disable)")
|
|
|
|
return root
|
|
}
|
|
|
|
func main() {
|
|
if err := newRootCmd().Execute(); err != nil {
|
|
if errors.Is(err, errNothingToRelease) {
|
|
exitFn(2)
|
|
return
|
|
}
|
|
exitFn(1)
|
|
}
|
|
}
|
|
|
|
type options struct {
|
|
init bool
|
|
verbose bool
|
|
repoPath string
|
|
branchOverride string
|
|
pomOverride string
|
|
changelogFile string
|
|
tagPrefixFlag string
|
|
tagPrefixSet bool
|
|
patternFlag string
|
|
patternSet bool
|
|
dryRun bool
|
|
noPush bool
|
|
noRelease bool
|
|
noCommit bool
|
|
tagOnly bool
|
|
releaseEnvFile string
|
|
}
|
|
|
|
func printVerboseConfig(cfg config.Config, src config.Sources) {
|
|
logSection("configuration")
|
|
rows := []struct{ key, val string }{
|
|
{"git.tag_prefix", cfg.Git.TagPrefix},
|
|
{"git.branch_pattern", cfg.Git.BranchPattern},
|
|
{"git.commit_message", cfg.Git.CommitMessage},
|
|
{"git.author_name", cfg.Git.AuthorName},
|
|
{"git.author_email", cfg.Git.AuthorEmail},
|
|
{"git.releasable_types", func() string {
|
|
if len(cfg.Git.ReleasableTypes) == 0 {
|
|
return "(all)"
|
|
}
|
|
return strings.Join(cfg.Git.ReleasableTypes, ", ")
|
|
}()},
|
|
{"maven.pom_path", cfg.Maven.PomPath},
|
|
{"gitlab.url", cfg.GitLab.URL},
|
|
{"gitlab.token", func() string {
|
|
if cfg.GitLab.Token != "" {
|
|
return "(set)"
|
|
}
|
|
return "(not set)"
|
|
}()},
|
|
{"gitlab.project", cfg.GitLab.Project},
|
|
{"github.token", func() string {
|
|
if cfg.GitHub.Token != "" {
|
|
return "(set)"
|
|
}
|
|
return "(not set)"
|
|
}()},
|
|
{"github.repo", cfg.GitHub.Repo},
|
|
}
|
|
for _, r := range rows {
|
|
source := src[r.key]
|
|
if source == "" {
|
|
source = "default"
|
|
}
|
|
val := r.val
|
|
if val == "" {
|
|
val = paint(ansiDim, "(empty)")
|
|
}
|
|
fmt.Fprintf(os.Stderr, " %-25s = %-45s %s\n", r.key, val, fmtSource(source))
|
|
}
|
|
}
|
|
|
|
func initConfig(absRepo string) error {
|
|
path := filepath.Join(absRepo, ".releaser.yml")
|
|
if _, err := os.Stat(path); err == nil {
|
|
return fmt.Errorf(".releaser.yml already exists in %s — delete it first if you want to reset", absRepo)
|
|
}
|
|
if err := os.WriteFile(path, []byte(defaultConfigTemplate), 0644); err != nil {
|
|
return fmt.Errorf("write .releaser.yml: %w", err)
|
|
}
|
|
fmt.Printf("created %s\n", path)
|
|
return nil
|
|
}
|
|
|
|
func run(o options) error {
|
|
logHeader(version)
|
|
|
|
// --- Config ---
|
|
absRepo, err := filepath.Abs(o.repoPath)
|
|
if err != nil {
|
|
return fmt.Errorf("resolve repo path: %w", err)
|
|
}
|
|
|
|
if o.init {
|
|
if o.verbose {
|
|
logStep("creating .releaser.yml in %s", absRepo)
|
|
}
|
|
return initConfig(absRepo)
|
|
}
|
|
|
|
cfg, src, err := config.LoadWithSources(absRepo)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
cfg.ApplyEnvWithSources(src)
|
|
|
|
// CLI flags take precedence over config file and env vars
|
|
if o.tagPrefixSet {
|
|
cfg.Git.TagPrefix = o.tagPrefixFlag
|
|
src["git.tag_prefix"] = "flag: --tag-prefix"
|
|
}
|
|
if o.pomOverride != "" {
|
|
cfg.Maven.PomPath = o.pomOverride
|
|
src["maven.pom_path"] = "flag: --pom"
|
|
}
|
|
if o.patternSet {
|
|
cfg.Git.BranchPattern = o.patternFlag
|
|
src["git.branch_pattern"] = "flag: --branch-pattern"
|
|
}
|
|
|
|
if o.verbose {
|
|
printVerboseConfig(cfg, src)
|
|
}
|
|
|
|
// --- Git ---
|
|
repo, err := gogit.PlainOpenWithOptions(absRepo, &gogit.PlainOpenOptions{DetectDotGit: true})
|
|
if err != nil {
|
|
return fmt.Errorf("open repository: %w", err)
|
|
}
|
|
|
|
branchName := o.branchOverride
|
|
if branchName == "" {
|
|
branchName, err = gitutil.CurrentBranch(repo)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
info, err := branch.Parse(branchName, cfg.Git.BranchPattern)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
info.TagPrefix = cfg.Git.TagPrefix
|
|
|
|
if o.verbose {
|
|
logSection("branch")
|
|
fmt.Fprintf(os.Stderr, " %s → major=%d, minor=%d %s\n",
|
|
paint(ansiBold, branchName), info.Major, info.Minor,
|
|
paint(ansiDim, "(pinned by branch)"))
|
|
}
|
|
|
|
// --- Dirty check (before any changes) ---
|
|
// Skipped in --no-commit mode: the user intentionally has changes in flight.
|
|
if !o.dryRun && !o.noCommit {
|
|
clean, err := gitutil.IsWorkingTreeClean(repo)
|
|
if err != nil {
|
|
return fmt.Errorf("check working tree: %w", err)
|
|
}
|
|
if !clean {
|
|
return fmt.Errorf("working tree has uncommitted changes — commit or stash them before releasing")
|
|
}
|
|
}
|
|
|
|
// --- Tag discovery ---
|
|
lastTag, currentPatch, err := gitutil.LatestTag(repo, info)
|
|
if err != nil {
|
|
return fmt.Errorf("find latest tag: %w", err)
|
|
}
|
|
|
|
// --- Commit range ---
|
|
var messages []string
|
|
if lastTag == "" {
|
|
messages, err = gitutil.AllCommits(repo)
|
|
} else {
|
|
messages, err = gitutil.CommitsSince(repo, lastTag)
|
|
}
|
|
if err != nil {
|
|
return fmt.Errorf("read commits: %w", err)
|
|
}
|
|
|
|
if !o.verbose {
|
|
if lastTag == "" {
|
|
logStep("no previous tag — scanning all %d commit(s)", len(messages))
|
|
} else {
|
|
logStep("last tag: %s (%d commit(s) to analyze)", lastTag, len(messages))
|
|
}
|
|
}
|
|
|
|
// --- Version calculation ---
|
|
types := make([]commits.Type, len(messages))
|
|
for i, msg := range messages {
|
|
types[i] = commits.Parse(msg)
|
|
}
|
|
|
|
if o.verbose {
|
|
logSection(fmt.Sprintf("commits (%d)", len(messages)))
|
|
if lastTag != "" {
|
|
fmt.Fprintf(os.Stderr, " since: %s (patch=%d)\n", paint(ansiCyan, lastTag), currentPatch)
|
|
}
|
|
for i, msg := range messages {
|
|
first := strings.SplitN(strings.TrimSpace(msg), "\n", 2)[0]
|
|
if len(first) > 70 {
|
|
first = first[:67] + "..."
|
|
}
|
|
t := types[i]
|
|
typeLabel := fmt.Sprintf("%-9s", t.String())
|
|
if t == commits.TypeNone {
|
|
fmt.Fprintf(os.Stderr, " %s\n", paint(ansiDim, typeLabel+first))
|
|
} else {
|
|
var col string
|
|
switch t {
|
|
case commits.TypeBreaking:
|
|
col = ansiRed + ansiBold
|
|
case commits.TypeFeat:
|
|
col = ansiCyan
|
|
default: // fix
|
|
col = ansiGreen
|
|
}
|
|
fmt.Fprintf(os.Stderr, " %s %s %s\n",
|
|
paint(col, typeLabel), first, paint(ansiDim, "→ patch bump"))
|
|
}
|
|
}
|
|
}
|
|
|
|
releasable := commits.ReleasableSet(cfg.Git.ReleasableTypes)
|
|
nextVersion, ok := semver.Next(info.Major, info.Minor, currentPatch, types, releasable)
|
|
if !ok {
|
|
logWarn("no releasable commits found")
|
|
return errNothingToRelease
|
|
}
|
|
|
|
nextTag := info.TagName(nextVersion)
|
|
|
|
if o.verbose {
|
|
highestType := commits.TypeNone
|
|
for _, t := range types {
|
|
if t > highestType {
|
|
highestType = t
|
|
}
|
|
}
|
|
logSection("version")
|
|
fmt.Fprintf(os.Stderr, " highest type: %s → next: %s (tag: %s)\n",
|
|
paint(ansiCyan, highestType.String()),
|
|
paint(ansiBold, nextVersion),
|
|
paint(ansiBold+ansiCyan, nextTag))
|
|
}
|
|
|
|
fmt.Printf("next version: %s (tag: %s)\n", nextVersion, nextTag)
|
|
|
|
if o.dryRun {
|
|
logStep("dry-run: no changes made")
|
|
return nil
|
|
}
|
|
|
|
// --- release.env (GitLab CI dotenv artifact) ---
|
|
if o.releaseEnvFile != "" {
|
|
releaseEnvPath := filepath.Join(absRepo, o.releaseEnvFile)
|
|
if err := os.WriteFile(releaseEnvPath, []byte("NEXT_VERSION="+nextTag+"\n"), 0644); err != nil {
|
|
return fmt.Errorf("write %s: %w", o.releaseEnvFile, err)
|
|
}
|
|
logDone("%s: NEXT_VERSION=%s", o.releaseEnvFile, nextTag)
|
|
}
|
|
|
|
// --- pom.xml + CHANGELOG.md (skipped with --tag-only) ---
|
|
if !o.tagOnly {
|
|
var filesToCommit []string
|
|
|
|
// pom.xml
|
|
pomPath := filepath.Join(absRepo, cfg.Maven.PomPath)
|
|
_, statErr := os.Stat(pomPath)
|
|
hasPom := !errors.Is(statErr, os.ErrNotExist)
|
|
if statErr != nil && hasPom {
|
|
return fmt.Errorf("check pom path: %w", statErr)
|
|
}
|
|
if hasPom {
|
|
currentPomVersion, err := maven.ReadVersion(pomPath)
|
|
if err != nil {
|
|
return fmt.Errorf("read pom version: %w", err)
|
|
}
|
|
if err := maven.WriteVersion(pomPath, currentPomVersion, nextVersion); err != nil {
|
|
return fmt.Errorf("update pom version: %w", err)
|
|
}
|
|
logDone("pom.xml: %s → %s", currentPomVersion, nextVersion)
|
|
filesToCommit = append(filesToCommit, cfg.Maven.PomPath)
|
|
} else {
|
|
logWarn("no pom.xml — skipping version bump")
|
|
}
|
|
|
|
// CHANGELOG.md
|
|
changelogAbsPath := filepath.Join(absRepo, o.changelogFile)
|
|
if err := changelog.Update(changelogAbsPath, nextTag, nextVersion, messages); err != nil {
|
|
return fmt.Errorf("update changelog: %w", err)
|
|
}
|
|
logDone("%s updated", o.changelogFile)
|
|
filesToCommit = append(filesToCommit, o.changelogFile)
|
|
|
|
if o.noCommit {
|
|
fmt.Printf("files updated to %s — commit manually then re-run with --tag-only\n", nextVersion)
|
|
return nil
|
|
}
|
|
|
|
// --- Git commit ---
|
|
authorName, authorEmail := gitutil.AuthorFromConfig(repo)
|
|
if cfg.Git.AuthorName != "" {
|
|
authorName = cfg.Git.AuthorName
|
|
}
|
|
if cfg.Git.AuthorEmail != "" {
|
|
authorEmail = cfg.Git.AuthorEmail
|
|
}
|
|
commitMsg := strings.ReplaceAll(cfg.Git.CommitMessage, "{version}", nextTag)
|
|
if _, err := gitutil.CommitFiles(repo, filesToCommit, commitMsg, authorName, authorEmail); err != nil {
|
|
return fmt.Errorf("commit: %w", err)
|
|
}
|
|
logDone("committed: %s", commitMsg)
|
|
}
|
|
|
|
// --- Git tag ---
|
|
if err := gitutil.CreateTag(repo, nextTag); err != nil {
|
|
return fmt.Errorf("create tag: %w", err)
|
|
}
|
|
logDone("tag: %s", nextTag)
|
|
|
|
if o.noPush {
|
|
fmt.Printf("released %s locally — push manually with: git push && git push --tags\n", nextTag)
|
|
return nil
|
|
}
|
|
|
|
// --- Push ---
|
|
logStep("pushing commit and tag...")
|
|
if err := gitutil.Push(repo, branchName, nextTag, cfg.GitLab.Token); err != nil {
|
|
return fmt.Errorf("push: %w", err)
|
|
}
|
|
logDone("pushed")
|
|
|
|
if o.noRelease {
|
|
fmt.Printf("released %s\n", nextTag)
|
|
return nil
|
|
}
|
|
|
|
// --- Release creation ---
|
|
publisher, err := buildPublisher(cfg)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if publisher == nil {
|
|
logWarn("no release provider configured — skipping release creation")
|
|
fmt.Printf("released %s\n", nextTag)
|
|
return nil
|
|
}
|
|
|
|
releaseNotes := notes.Generate(nextTag, messages)
|
|
if err := publisher.CreateRelease(context.Background(), nextTag, releaseNotes); err != nil {
|
|
return fmt.Errorf("create release: %w", err)
|
|
}
|
|
logDone("release created: %s", nextTag)
|
|
fmt.Printf("released %s\n", nextTag)
|
|
return nil
|
|
}
|