Skip to content

Commit

Permalink
Update readme for releasing
Browse files Browse the repository at this point in the history
  • Loading branch information
Shell32-Natsu committed May 21, 2020
1 parent 4d88032 commit 4b68425
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 13 deletions.
13 changes: 2 additions & 11 deletions releasing/README.md
Expand Up @@ -112,17 +112,8 @@ The tag appears in the URL, e.g. [pluginator/v1.0.0].

## Release procedure

> TODO: script what follows, so someone can enter
> ```
> go run ./releasing/release.go kustomize minor
> # or:
> # go run ./releasing/release.go api patch
> # go run ./releasing/release.go pluginator minor
> ```
> The program would look at the existing remote tags,
> confirm sanity and increment the appropriate major/minor/patch
> component, create the right branch and tag, etc.
> No more bash please.
The script used to release modules is in progress. Check it in
`releasing/releasing` directory.

At any given moment, the repository's master branch is
passing all its tests and contains code one could release.
Expand Down
5 changes: 3 additions & 2 deletions releasing/releasing/main.go
Expand Up @@ -49,8 +49,9 @@ func logFatalE(e error) {
// === Command line commands ===

var rootCmd = &cobra.Command{
Use: "releasing",
Short: "This go program is used to improve the modules releasing process in Kustomize repository.",
Use: "releasing",
Short: `This go program is used to improve the modules releasing process in Kustomize repository.
Note: You may need to run fixgomod.sh in the module to make the module ready to release.`,
}

func listCmdImpl() error {
Expand Down

0 comments on commit 4b68425

Please sign in to comment.