fix(releasedefn-generate): Update example commands and typos (#1431)

fixes #1430 Co-authored-by: Vu Ha <>
dxatscale · Oct 26, 2023 · b56ec85 · b56ec85
1 parent ccdc73f
commit b56ec85
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/packages/sfpowerscripts-cli/messages/releasedefinition_generate.json b/packages/sfpowerscripts-cli/messages/releasedefinition_generate.json
@@ -1,10 +1,10 @@
 {
-    "commandDescription": "Generates release defintion based on the artifacts installed from a commit reference",
-    "configFileFlagDescription":"Path to the config file which determines how the release defintion should be generated",
-    "releaseNameFlagDescription": "Set a releasename on the release definition file created",
+    "commandDescription": "Generates release definition based on the artifacts installed from a commit reference",
+    "configFileFlagDescription":"Path to the config file which determines how the release definition should be generated",
+    "releaseNameFlagDescription": "Set a release name on the release definition file created",
     "commitFlagDescription": "Utilize the tags on the source branch to generate release definiton",
-    "directoryFlagDescription": "Relative path to directory to which the release defintion file should be generated, if the directory doesnt exist, it will be created",
-    "branchNameFlagDescription": "Repository branch in which the release defintion files are to be written",
+    "directoryFlagDescription": "Relative path to directory to which the release definition file should be generated, if the directory doesnt exist, it will be created",
+    "branchNameFlagDescription": "Repository branch in which the release definition files are to be written",
     "noPushFlagDescription":"Do not push the changelog to a repository to the provided branch",
     "forcePushFlagDescription": "Force push changes to the repository branch"
 }
diff --git a/packages/sfpowerscripts-cli/src/commands/releasedefinition/generate.ts b/packages/sfpowerscripts-cli/src/commands/releasedefinition/generate.ts
@@ -12,7 +12,7 @@ export default class Generate extends SfpowerscriptsCommand {
     public static description = messages.getMessage('commandDescription');
 
     public static examples = [
-        `$ sfp releasedefinition:generate -n <releaseName>`,
+        `$ sfp releasedefinition:generate -n <releaseName> -c <gitref> -f <configfile>`,
     ];
 
     protected static requiresProject = true;
@@ -22,7 +22,7 @@ export default class Generate extends SfpowerscriptsCommand {
         gitref: Flags.string({
             char: 'c',
             description: messages.getMessage('commitFlagDescription'),
-            required:true
+            required: true
         }),
         configfile: Flags.string({
             char: 'f',