Closed GrantBirki closed 2 months ago
.noop
This help message was automatically generated based on the inputs provided to this Action.
.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
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 environments that are considered "production"production,development,staging
- The list of environments that can be targeted for deploymentThe 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 environmentThe 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 branchoutdated_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 repositoriesskipCi: false
- This Action will require passing CI for all environmentschecks: all
- All CI checks must pass before a deployment can be requestedskipReviews: false
- This Action will require passing reviews for all environmentsdraft_permitted_targets: false
- This Action will not draft pull requests to be deployed to any environmentadmins: 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 runallow_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, started a noop deployment to production
You can watch the progress here 🔗
noop:
test
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:.
This was a noop deployment.
Please make sure to get a review on this pull request as you currently have none
.deploy
GrantBirki, started a branch deployment to production
You can watch the progress here 🔗
Branch:
test
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:.
.noop
Your branch is behind the base branch and will need to be updated before deployments can continue.
BEHIND
warn
Please ensure your branch is up to date with the
main
branch and try again
.deploy
Your branch is behind the base branch and will need to be updated before deployments can continue.
BEHIND
warn
Please ensure your branch is up to date with the
main
branch and try again
.deploy
GrantBirki, started a branch deployment to production
You can watch the progress here 🔗
Branch:
test
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:.
.deploy
BEHIND
force
I went ahead and updated your branch with
main
- Please try again once this operation is complete
.deploy
null
PENDING
CI checks must be passing in order to continue
.deploy
GrantBirki, started a branch deployment to production
You can watch the progress here 🔗
Branch:
test
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:.
.help
.noop to development
This help message was automatically generated based on the inputs provided to this Action.
.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
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 environments that are considered "production"production,development,staging
- The list of environments that can be targeted for deploymentThe 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 environmentThe 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 branchoutdated_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 repositoriesskipCi: false
- This Action will require passing CI for all environmentschecks: all
- All CI checks must pass before a deployment can be requestedskipReviews: false
- This Action will require passing reviews for all environmentsdraft_permitted_targets: false
- This Action will not draft pull requests to be deployed to any environmentadmins: 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 runallow_sha_deployments: true
- This Action will allow deployments to an exact SHA (potentially dangerous/unsafe)View the full usage guide here for additional help
.deploy
GrantBirki, started a noop deployment to development
You can watch the progress here 🔗
noop:
test
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 development environment. This deployment was a success :rocket:.
This was a noop deployment.
Please make sure to get a review on this pull request as you currently have none
GrantBirki, started a branch deployment to production
You can watch the progress here 🔗
Branch:
test
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:.
.deploy development
GrantBirki, started a branch deployment to development
You can watch the progress here 🔗
Branch:
test
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 development environment. This deployment was a success :rocket:.
.deploy main
GrantBirki, started a branch deployment to production
You can watch the progress here 🔗
Branch:
main
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:.
.deploy to foo | value=1
No matching environment target found. Please check your command and try again. You can read more about environment targets in the README of this Action.
The following environment targets are available:
production,development,staging
.deploy development to main
No matching environment target found. Please check your command and try again. You can read more about environment targets in the README of this Action.
The following environment targets are available:
production,development,staging
.deploy main to development
GrantBirki, started a branch deployment to development
You can watch the progress here 🔗
Branch:
main
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 development environment. This deployment was a success :rocket:.
.deploy production | foo=value1
GrantBirki, started a branch deployment to production
You can watch the progress here 🔗
Branch:
test
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:.
.deploy
GrantBirki, started a branch deployment to production
You can watch the progress here 🔗
Branch:
test
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:.
.deploy to production
.help