github-actions[bot]
commented
1 year ago 📚 Branch Deployment Help
This help message was automatically generated based on the inputs provided to this Action.
💻 Available Commands
.help- Show this help message.deploy- Deploy this branch to theproductionenvironment.deploy main- Rollback theproductionenvironment to themainbranch.deploy noop- Deploy this branch to theproductionenvironment in noop mode.lock- Obtain the deployment lock (will persist until the lock is released).lock --reason <text>- Obtain the deployment lock with a reason (will persist until the lock is released).lock <environment>- Obtain the deployment lock for the specified environment (will persist until the lock is released).lock <environment> --reason <text>- Obtain the deployment lock for the specified environment with a reason (will persist until the lock is released).lock --global- Obtain a global deployment lock (will persist until the lock is released) - Blocks all environments.lock --global --reason <text>- Obtain a global deployment lock with a reason (will persist until the lock is released) - Blocks all environments.unlock- Release the deployment lock (if one exists).unlock <environment>- Release the deployment lock for the specified environment (if one exists).unlock --global- Release the global deployment lock (if one exists).lock --details- Show information about the current deployment lock (if one exists).lock <environment> --details- Get information about the current deployment lock for the specified environment (if one exists).lock --global --details- Show information about the current global deployment lock (if one exists).wcid- Alias for.lock --details
🌍 Environments
These are the available environments for this Action as defined by the inputs provided to this Action.
Note: Just because an environment is listed here does not mean it is available for deployment
production- The default environment for this Actionproduction- The environment that is considered "production"production,sandbox- The list of environments that can be targeted for deployment
🔭 Example Commands
The following set of examples use this Action's inputs to show you how to use the commands.
.deploy- Deploy this branch to theproductionenvironment.deploy main- Rollback theproductionenvironment to themainbranch.deploy noop- Deploy this branch to theproductionenvironment in noop mode.deploy to <production|sandbox>- Deploy this branch to the specified environment (note: thetokeyword is optional).lock <production|sandbox>- Obtain the deployment lock for the specified environment.unlock <production|sandbox>- Release the deployment lock for the specified environment.lock <production|sandbox> --details- Get information about the deployment lock for the specified environment
⚙️ Configuration
The following configuration options have been defined for this Action:
reaction: eyes- The GitHub reaction icon to add to the deployment comment when a deployment is triggeredupdate_branch: warn- This Action will warn if the branch is out of date with the base branchrequired_contexts: false- There are no designated required contexts for this Action (default and suggested)allowForks: true- This Action will not run on forked repositoriesskipCi: false- This Action will require passing CI for all environmentsskipReviews: false- This Action will require passing reviews for all environmentsdraft_permitted_targets: sandbox- This Action will allow draft pull requests to request deployments to the listed environmentsadmins: grantbirki- This Action will allow the listed admins to bypass pull request reviews before deploymentpermissions: write,maintain,admin- The acceptable permissions that this Action will require to run
View the full usage guide here for additional help
GrantBirki
.help