root/golib
1
0
Fork 0
mirror of https://github.com/therootcompany/golib.git synced 2026-03-02 23:57:59 +00:00
Code Issues Projects Releases Wiki Activity

feat(monorel): pre-compute release notes into the generated script

Browse Source 
Instead of emitting a runtime git log command in Step 4, run git log at
monorel-invocation time and embed the actual commit list as a
single-quoted bash string (with '\'' escaping for embedded apostrophes).

  my_release_notes='- abc1234 first commit
  - def5678 fix: don'\''t crash'

This makes the generated script self-contained and shows the user exactly
which commits will appear in the release notes before they run the script.
Removes the now-unused gitPathSpec local variable.
This commit is contained in:
AJ ONeal 2026-02-28 23:26:05 -07:00
parent 3d065f4a41
commit bcd70c3843
No known key found for this signature in database
1 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
tools/monorel/main.go
View File

@ -997,6 +997,17 @@ func processModule(group *moduleGroup, relPath string) {
prevTag = latestTag
}
// Pre-compute release notes now so the generated script contains the
// actual commit list rather than a git command the user must re-run.
var releaseNotes string
if prevTag != "" {
releaseNotes = runIn(modRoot, "git", "--no-pager", "log", prevTag+"..HEAD",
"--pretty=format:- %h %s", "--", ".")
} else {
releaseNotes = runIn(modRoot, "git", "--no-pager", "log",
"--pretty=format:- %h %s", "--", ".")
}
// Write .goreleaser.yaml next to go.mod.
// Warn if an existing file uses {{ .ProjectName }} (stock goreleaser config)
// and the module is a monorepo subdirectory (go.mod not adjacent to .git/).
@ -1020,7 +1031,7 @@ func processModule(group *moduleGroup, relPath string) {
headSHA := mustRunIn(modRoot, "git", "rev-parse", "HEAD")
printModuleScript(relPath, projectName, bins,
version, currentTag, prevTag, repoPath, headSHA,
isPreRelease, needsNewTag, isDirty)
releaseNotes, isPreRelease, needsNewTag, isDirty)
}
// ── Version computation ────────────────────────────────────────────────────
@ -1207,6 +1218,7 @@ func printModuleScript(
relPath string,
projectName string, bins []binary,
version, currentTag, prevTag, repoPath, headSHA string,
releaseNotes string,
isPreRelease, needsNewTag, isDirty bool,
) {
line := func(format string, args ...any) { fmt.Printf(format+"\n", args...) }
@ -1218,12 +1230,10 @@ func printModuleScript(
}
// Paths used in the generated script, all relative to the invoking CWD.
var gitPathSpec, distDir string
var distDir string
if relPath == "." {
gitPathSpec = "./"
distDir = "./dist"
} else {
gitPathSpec = relPath + "/"
distDir = relPath + "/dist"
}
@ -1287,14 +1297,8 @@ func printModuleScript(
line(")")
}
section("Step 4: Generate release notes")
if prevTag != "" {
line("%s=$(git --no-pager log %q..HEAD \\", notesVar, prevTag)
line(" --pretty=format:'- %%h %%s' -- %s)", gitPathSpec)
} else {
line("%s=$(git --no-pager log \\", notesVar)
line(" --pretty=format:'- %%h %%s' -- %s)", gitPathSpec)
}
section("Step 4: Release notes")
line("%s=%s", notesVar, shellSingleQuote(releaseNotes))
section("Step 5: Create draft GitHub release")
tagVersion := currentTag[strings.LastIndex(currentTag, "/")+1:]
@ -1325,6 +1329,12 @@ func printModuleScript(
// ── Helpers ────────────────────────────────────────────────────────────────
// shellSingleQuote wraps s in bash single quotes, escaping any literal single
// quotes inside s as '\''. For example: it's → 'it'\''s'.
func shellSingleQuote(s string) string {
return "'" + strings.ReplaceAll(s, "'", "'\\''") + "'"
}
func normalizeGitURL(rawURL string) string {
rawURL = strings.TrimSpace(rawURL)
rawURL = strings.TrimSuffix(rawURL, ".git")