From ba674a673d5665824f8df05a16022ed4a28c2144 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Sun, 8 Mar 2026 17:18:01 -0600 Subject: [PATCH] doc(tools/monorel): move usage summary to doc.go --- tools/monorel/doc.go | 23 +++++++++++++++++++++++ tools/monorel/main.go | 23 ----------------------- 2 files changed, 23 insertions(+), 23 deletions(-) create mode 100644 tools/monorel/doc.go diff --git a/tools/monorel/doc.go b/tools/monorel/doc.go new file mode 100644 index 0000000..8de3f3b --- /dev/null +++ b/tools/monorel/doc.go @@ -0,0 +1,23 @@ +// monorel - Monorepo Release Tool +// +// Pass any number of paths to Go main packages. monorel walks up from each +// path to find its go.mod (stopping at .git so it never crosses the repo +// boundary), groups binaries by their module root, and performs the requested +// subcommand. +// +// Subcommands: +// +// monorel release ... +// Generate .goreleaser.yaml and print a ready-to-review bash release script. +// +// monorel bump [-r major|minor|patch] ... +// Create a new semver tag at the module's latest commit (default: patch). +// +// monorel init ... +// Write .goreleaser.yaml, commit it, and run bump patch for each module +// (processed in the order their paths appear on the command line). +// +// Install: +// +// go install github.com/therootcompany/golib/tools/monorel@latest +package main diff --git a/tools/monorel/main.go b/tools/monorel/main.go index 12ab8b0..3434cc4 100644 --- a/tools/monorel/main.go +++ b/tools/monorel/main.go @@ -1,5 +1,3 @@ -// monorel - Monorepo Release Tool -// // Copyright 2026 AJ ONeal // // This Source Code Form is subject to the terms of the Mozilla Public @@ -10,27 +8,6 @@ // defined by the Mozilla Public License, v. 2.0. // // SPDX-License-Identifier: MPL-2.0 -// -// Pass any number of paths to Go main packages. monorel walks up from each -// path to find its go.mod (stopping at .git so it never crosses the repo -// boundary), groups binaries by their module root, and performs the requested -// subcommand. -// -// Subcommands: -// -// monorel release ... -// Generate .goreleaser.yaml and print a ready-to-review bash release script. -// -// monorel bump [-r major|minor|patch] ... -// Create a new semver tag at the module's latest commit (default: patch). -// -// monorel init ... -// Write .goreleaser.yaml, commit it, and run bump patch for each module -// (processed in the order their paths appear on the command line). -// -// Install: -// -// go install github.com/therootcompany/golib/tools/monorel@latest package main import (