Skip to content

Add krel help and mention it in the README.md #1138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ development and testing.

Tools | Description
:---: | --
[`krel`](/cmd/krel) | Kubernetes Release Toolbox<br/>This is the new golang based tool for managing releases
[`gcbmgr`](/gcbmgr) | Google Cloud Builder Manager:<br/>This is the main entry point for release managers for producing releases. All release types can be staged and later released using this method.
[`anago`](/anago) | Release Tool:<br/>The main driver for creating staged builds and releases. This is what runs inside GCB after a job is submitted using `gcbmgr`.
[`branchff`](/branchff) | Fast-forward branching helper:<br/>A tool used to pull new patches onto the release branch.
Expand Down
2 changes: 1 addition & 1 deletion cmd/krel/cmd/changelog.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import (
// changelogCmd represents the subcommand for `krel changelog`
var changelogCmd = &cobra.Command{
Use: "changelog",
Short: "changelog maintains the lifecycle of CHANGELOG-x.y.{md,html} files",
Short: "Automate the lifecycle of CHANGELOG-x.y.{md,html} files in a k/k repository",
Long: fmt.Sprintf(`krel changelog

To let this tool work, please point '--repo' to a local copy of the target k/k
Expand Down
2 changes: 1 addition & 1 deletion cmd/krel/cmd/ff.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ var ffOpts = &ffOptions{}
// ffCmd represents the base command when called without any subcommands
var ffCmd = &cobra.Command{
Use: "ff --branch <release-branch> [--ref <master-ref>] [--nomock] [--cleanup]",
Short: "ff fast forwards a Kubernetes release branch",
Short: "Fast forward a Kubernetes release branch",
Long: fmt.Sprintf(`ff fast forwards a branch to a specified git object (defaults to %s).

krel ff pre-checks that the local branch to be forwarded is an actual
Expand Down
2 changes: 1 addition & 1 deletion cmd/krel/cmd/push.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ var pushBuildOpts = &pushBuildOptions{}

var pushBuildCmd = &cobra.Command{
Use: "push [--noupdatelatest] [--ci] [--bucket=<GS bucket>] [--private-bucket]",
Short: "push kubernetes release artifacts to GCS",
Short: "Push Kubernetes release artifacts to Google Cloud Storage (GCS)",
Example: description,
SilenceUsage: true,
SilenceErrors: true,
Expand Down
2 changes: 1 addition & 1 deletion cmd/krel/cmd/release_notes.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ const (
// releaseNotesCmd represents the subcommand for `krel release-notes`
var releaseNotesCmd = &cobra.Command{
Use: "release-notes",
Short: "release-notes is the tool of choice for the Release Notes subteam of SIG Release",
Short: "The subcommand of choice for the Release Notes subteam of SIG Release",
Long: fmt.Sprintf(`krel release-notes

The 'release-notes' subcommand of krel has been developed to:
Expand Down
13 changes: 11 additions & 2 deletions cmd/krel/cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,17 @@ import (

// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
Use: "krel",
Short: "krel",
Use: "krel",
Long: `krel - The Kubernetes Release toolbox

krel is the new golang based tool for managing releases. Target of krel is to
provide a toolkit for managing the different steps needed for creating
Kubernetes Releases. This includes manually executed tasks, like the generation
of the release notes during the release cycle, as well as automated tasks like
pushing the Kubernetes release artifacts to the Google Cloud Storage.

Each subcommand should contain its own self describing help output which
clarifies its purpose.`,
PersistentPreRunE: initLogging,
}

Expand Down