Skip to content

Commit

Permalink
Merge pull request #324 from github/feature/caridinl6-doc-update
Browse files Browse the repository at this point in the history
Docs updates about `.noop`
  • Loading branch information
GrantBirki authored Nov 27, 2024
2 parents 041fcdd + 0629067 commit 7b0a1f4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This Action does the heavy lifting for you to enable branch deployments:
## Available Commands 💬

- `.deploy` - Deploy a pull request
- `.noop` - Deploy a pull request in noop mode
- `.noop` - Deploy a pull request in noop mode. Noop deployments do not require a PR review or approval
- `.deploy to <environment>` - Deploy a pull request to a specific environment
- `.deploy <stable_branch>` - Trigger a rollback deploy to your stable branch (main, master, etc)
- `.lock` - Create a deployment lock for the default environment
Expand Down Expand Up @@ -157,7 +157,7 @@ Branch deployments are a battle tested way of deploying your changes to a given
- The `main` branch is always considered to be a stable and deployable branch
- All changes are deployed to production before they are merged to the `main` branch
- To roll back a branch deployment, you deploy the `main` branch
- `noop` deployments should not make changes but rather report what they "would" have done
- `noop` deployments should not make changes but rather report what they "would" have done and do not require approval or review before starting

#### Why use branch deployments?

Expand Down
3 changes: 3 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ Deployments respect your repository's branch protection settings. You can trigge
- `.deploy <stable_branch>` - Trigger a rollback deploy to your stable branch (main, master, etc)
- `.noop <stable_branch>` - Trigger a rollback noop to your stable branch (main, master, etc)

> [!NOTE]
> `.noop` does not require a PR approval or review in order to be executed. It is intended to be run before an approval or PR review is completed in most use cases.
## Deployment Locks 🔒

If you need to lock deployments so that only you can trigger them, you can use the following set of commands:
Expand Down

0 comments on commit 7b0a1f4

Please sign in to comment.