Skip to content

Commit f09e9d3

Browse files
committed
update docs
1 parent 973576e commit f09e9d3

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -636,13 +636,17 @@ Check out some of the links below to see how others are using this Action in the
636636

637637
## Suggestions 🌟
638638

639-
This section will cover a few suggestions that will help you when using this Action
639+
This section will cover a few suggestions and best practices that will help you when using this Action.
640640

641641
1. Suggest Updating Pull Request Branches - You should absolutely use this option when using the `branch-deploy` Action. This option can be found in your repository's `/settings` page
642642

643-
![branch-setting](https://user-images.githubusercontent.com/23362539/172939811-a8816db8-8e7c-404a-b12a-11ec5bc6e93d.png)
643+
![update-pr-branches](./docs//assets/update-branch-setting.png)
644644

645645
2. Enable Branch Protection Settings - It is always a good idea to enable branch protection settings for your repo, especially when using this Action
646+
1. Require Pull Request Reviews - Enforce that pull requests have approvals, code owner approvals, and dismiss stale pull request approvals upon new commits
647+
![use-pr-reviews](./docs/assets/pr-reviews.png)
648+
2. Add Required Status Checks - Enforce that certain CI checks must pass before a pull request can be merged
649+
![use-status-checks](./docs/assets/required-ci-checks.png)
646650

647651
## Alternate Command Syntax
648652

docs/assets/pr-reviews.png

69.8 KB
Loading

docs/assets/update-branch-setting.png

26.9 KB
Loading

0 commit comments

Comments
 (0)