From c18bb3e165171d8f9edb5874afee807c5cebb9ba Mon Sep 17 00:00:00 2001 From: Jay Gabriels Date: Sat, 3 Aug 2019 13:15:19 -0700 Subject: [PATCH] update flag documentation --- CHANGELOG.md | 10 ++++++++++ cmd/clone.go | 2 +- cmd/version.go | 2 +- 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 24eba4df32..144b710a90 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) ### Fixed ### Security +## [1.1.3] - 08/03/19 +### Added +### Changed +### Deprecated +### Removed +### Fixed +- flag documentation +### Security + + ## [1.1.2] - 08/03/19 ### Added ### Changed diff --git a/cmd/clone.go b/cmd/clone.go index c3852bc47b..b28d163bc4 100644 --- a/cmd/clone.go +++ b/cmd/clone.go @@ -30,7 +30,7 @@ func init() { cloneCmd.Flags().StringVarP(&path, "path", "p", "", "GHORG_ABSOLUTE_PATH_TO_CLONE_TO - absolute path the ghorg_* directory will be created (default $HOME/Desktop)") cloneCmd.Flags().StringVarP(&branch, "branch", "b", "", "GHORG_BRANCH - branch left checked out for each repo cloned (default master)") cloneCmd.Flags().StringVarP(&token, "token", "t", "", "GHORG_GITHUB_TOKEN/GHORG_GITLAB_TOKEN/GHORG_BITBUCKET_APP_PASSWORD - scm token to clone with") - cloneCmd.Flags().StringVarP(&bitbucketUsername, "bitbucket-username", "", "", "GHORG_BITBUCKET_USERNAME - when cloning with bitbucket this must be set or GHORG_BITBUKET_USERNAME in your $HOME/ghorg/conf.yaml") + cloneCmd.Flags().StringVarP(&bitbucketUsername, "bitbucket-username", "", "", "GHORG_BITBUCKET_USERNAME - bitbucket only: username associated with the app password") cloneCmd.Flags().StringVarP(&scmType, "scm", "s", "", "GHORG_SCM_TYPE - type of scm used, github, gitlab or bitbucket (default github)") // TODO: make gitlab terminology make sense https://about.gitlab.com/2016/01/27/comparing-terms-gitlab-github-bitbucket/ cloneCmd.Flags().StringVarP(&cloneType, "clone-type", "c", "", "GHORG_CLONE_TYPE - clone target type, user or org (default org)") diff --git a/cmd/version.go b/cmd/version.go index e288aae13b..594ef7bffc 100644 --- a/cmd/version.go +++ b/cmd/version.go @@ -15,6 +15,6 @@ var versionCmd = &cobra.Command{ Short: "Print the version number of Ghorg", Long: `All software has versions. This is Ghorg's`, Run: func(cmd *cobra.Command, args []string) { - fmt.Println("v1.1.2") + fmt.Println("v1.1.3") }, }