Merge pull request #294 from github/help-improvements

Improve `.help` command
github · Aug 9, 2024 · aaba0a8 · aaba0a8
2 parents cae4756 + fd9817e
commit aaba0a8
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 2 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/docs/usage.md b/docs/usage.md
@@ -47,7 +47,7 @@ It should be noted that anytime you use a `.lock`, `.unlock`, or `.lock --detail
 
 If something goes wrong and you need to redeploy the main/master/base branch of your repository, you can use the following set of commands:
 
-- `.deploy main` - Rolls back to the `main` branch in production
+- `.deploy main` - Rolls back to the `main` branch in production (or the defined default environment)
 - `.deploy main to <environment>` - Rolls back to the `main` branch in the specified environment
 - `.noop main` - Rolls back to the `main` branch in production as a noop deploy
 - `.noop main to <environment>` - Rolls back to the `main` branch in the specified environment as a noop deploy

diff --git a/src/functions/help.js b/src/functions/help.js
@@ -152,6 +152,7 @@ export async function help(octokit, context, reactionId, inputs) {
   - \`${inputs.trigger} ${inputs.stable_branch}\` - Rollback the \`${
     inputs.environment
   }\` environment to the \`${inputs.stable_branch}\` branch
+  - \`${inputs.trigger} ${inputs.stable_branch} to <environment>\` - Rollback the specified \`<environment>\` to the \`${inputs.stable_branch}\` branch (long form syntax)
   - \`${inputs.noop_trigger}\` - Deploy this branch to the \`${
     inputs.environment
   }\` environment in noop mode