doc(tools/monorel): move usage summary to doc.go

This commit is contained in:
AJ ONeal 2026-03-08 17:18:01 -06:00
parent f2302d2f24
commit ba674a673d
No known key found for this signature in database
2 changed files with 23 additions and 23 deletions

23
tools/monorel/doc.go Normal file
View File

@ -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 <binary-path>...
// Generate .goreleaser.yaml and print a ready-to-review bash release script.
//
// monorel bump [-r major|minor|patch] <binary-path>...
// Create a new semver tag at the module's latest commit (default: patch).
//
// monorel init <binary-path>...
// 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

View File

@ -1,5 +1,3 @@
// monorel - Monorepo Release Tool
//
// Copyright 2026 AJ ONeal <aj@therootcompany.com> // Copyright 2026 AJ ONeal <aj@therootcompany.com>
// //
// This Source Code Form is subject to the terms of the Mozilla Public // 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. // defined by the Mozilla Public License, v. 2.0.
// //
// SPDX-License-Identifier: MPL-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 <binary-path>...
// Generate .goreleaser.yaml and print a ready-to-review bash release script.
//
// monorel bump [-r major|minor|patch] <binary-path>...
// Create a new semver tag at the module's latest commit (default: patch).
//
// monorel init <binary-path>...
// 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 package main
import ( import (