test

[GrantBirki]

.deploy to production

[github-actions[bot]]

Deployment Triggered 🚀

GrantBirki, started a branch deployment to production

You can watch the progress here 🔗

Branch: test

[github-actions[bot]]

Deployment Results :rocket:

The following variables are available to use in this template:

• environment - The name of the environment (String)
• environment_url - The URL of the environment (String) {Optional}
• status - The status of the deployment (String) - success, failure, or unknown
• noop - Whether or not the deployment is a noop (Boolean)
• ref - The ref of the deployment (String)
• actor - The GitHub username of the actor who triggered the deployment (String)

Here is an example:

GrantBirki deployed branch test to the production environment. This deployment was a success :rocket:.

[GrantBirki]

.help

[github-actions[bot]]

📚 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 the production environment
• .deploy main - Rollback the production environment to the main branch
• .noop - Deploy this branch to the production environment 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 Action
• production - The environments that are considered "production"
• production,development,staging - 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 the production environment
• .deploy main - Rollback the production environment to the main branch
• .deploy main to <environment> - Rollback the specified <environment> to the main branch (long form syntax)
• .noop - Deploy this branch to the production environment in noop mode
• .deploy to <production|development|staging> - Deploy this branch to the specified environment (note: the to keyword is optional)
• .lock <production|development|staging> - Obtain the deployment lock for the specified environment
• .unlock <production|development|staging> - Release the deployment lock for the specified environment
• .lock <production|development|staging> --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 triggered
• update_branch: warn - This Action will warn if the branch is out of date with the base branch
• outdated_mode: strict
• required_contexts: false - There are no designated required contexts for this Action (default and suggested)
• allowForks: true - This Action will not run on forked repositories
• skipCi: false - This Action will require passing CI for all environments
• checks: all - All CI checks must pass before a deployment can be requested
• skipReviews: false - This Action will require passing reviews for all environments
• draft_permitted_targets: false - This Action will not draft pull requests to be deployed to any environment
• admins: grantbirki - This Action will allow the listed admins to bypass pull request reviews before deployment
• permissions: write,maintain,admin - The acceptable permissions that this Action will require to run
• allow_sha_deployments: true - This Action will allow deployments to an exact SHA (potentially dangerous/unsafe)

---

View the full usage guide here for additional help

[GrantBirki]

.deploy main to production

[github-actions[bot]]

Deployment Triggered 🚀

GrantBirki, started a branch deployment to production

You can watch the progress here 🔗

Branch: main

[github-actions[bot]]

Deployment Results :rocket:

The following variables are available to use in this template:

• environment - The name of the environment (String)
• environment_url - The URL of the environment (String) {Optional}
• status - The status of the deployment (String) - success, failure, or unknown
• noop - Whether or not the deployment is a noop (Boolean)
• ref - The ref of the deployment (String)
• actor - The GitHub username of the actor who triggered the deployment (String)

Here is an example:

GrantBirki deployed branch main to the production environment. This deployment was a success :rocket:.