Skip to content

Commit

Permalink
Improve help section
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Sverdlov <[email protected]>
  • Loading branch information
sverdlov93 committed Apr 24, 2024
1 parent 3446990 commit 30326c0
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/artifactory/buildaddgit/help.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ package buildaddgit
var Usage = []string{"rt bag [command options] <build name> <build number> [Path To .git]"}

func GetDescription() string {
return "Collect VCS details from git and add them to a build."
return "Collects the Git revision and URL from the local .git directory and adds it to the build-info.\n" +
"It can also collect the list of tracked project issues (for example, issues stored in JIRA or other bug tracking systems) and add them to the build-info.\n" +
"The issues are collected by reading the git commit messages from the local git log.\n" +
"Each commit message is matched against a pre-configured regular expression, which retrieves the issue ID and issue summary.\n" +
"The information required for collecting the issues is retrieved from a yaml configuration file provided to the command."
}

func GetArguments() string {
Expand Down

0 comments on commit 30326c0

Please sign in to comment.