branch-deploy demo

[GrantBirki]

Branch Deploy Demo 📹

This pull request demonstrates how to use to github/branch-deploy Action

[GrantBirki]

.noop

[github-actions[bot]]

Deployment Triggered 🚀

GrantBirki, started a noop deployment to production

You can watch the progress here 🔗

Branch: branch-deploy-demo

[github-actions[bot]]

Deployment Results ✅

GrantBirki successfully noop deployed branch branch-deploy-demo to production

[GrantBirki]

.deploy

[github-actions[bot]]

Deployment Triggered 🚀

GrantBirki, started a branch deployment to production

You can watch the progress here 🔗

Branch: branch-deploy-demo

[github-actions[bot]]

Deployment Results ✅

GrantBirki successfully deployed branch branch-deploy-demo to production

[GrantBirki]

.deploy to development

[github-actions[bot]]

Deployment Triggered 🚀

GrantBirki, started a branch deployment to development

You can watch the progress here 🔗

Branch: branch-deploy-demo

[github-actions[bot]]

Deployment Results ✅

GrantBirki successfully deployed branch branch-deploy-demo to development

[GrantBirki]

.lock production --reason I am testing a very risky change

[github-actions[bot]]

🔒 Deployment Lock Information

GrantBirki, you are already the owner of the current production environment deployment lock

The current lock has been active for 1d:7h:18m:20s

If you need to release the lock, please comment .unlock production

[GrantBirki]

.unlock production

[github-actions[bot]]

🔓 Deployment Lock Removed

The production deployment lock has been successfully removed

[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 ✅

GrantBirki successfully deployed branch main to production

[GrantBirki]

.noop main to development

[github-actions[bot]]

Deployment Triggered 🚀

GrantBirki, started a noop deployment to development

You can watch the progress here 🔗

Branch: main

[github-actions[bot]]

Deployment Results ✅

GrantBirki successfully noop deployed branch main to development

[GrantBirki]

.lock --global --reason there are fires in all environments right now

[github-actions[bot]]

🔒 Deployment Lock Claimed

This is a global deploy lock - All environments are now locked

You are now the only user that can trigger deployments globally until the deployment lock is removed

This lock is sticky and will persist until someone runs .unlock --global

[GrantBirki]

.lock --info

[github-actions[bot]]

Lock Details 🔒

The deployment lock is currently claimed by GrantBirki This is a global deploy lock - All environments are currently locked

• Reason: there are fires in all environments right now
• Branch: branch-deploy-demo
• Created At: 2023-07-19T22:24:33.052Z
• Created By: GrantBirki
• Sticky: true
• Environments: all
• Global: true
• Comment Link: click here
• Lock Link: click here

The current lock has been active for 0d:0h:0m:27s

If you need to release the lock, please comment .unlock --global

[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 environment that is 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
• .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
• 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
• 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

---

View the full usage guide here for additional help