GitHub Flow - An example

An example implementation of GitHub Flow with CI & CD

Repository Settings

The following settings are considered essential to achieve maximum workflow results:

General

Pull Requests

Always suggest updating pull request branches
Allow auto-merge
Automatically delete head branches

Pushes

Limit how many branches and tags can be updated in a single push Up to 5 branches and tags can be updated in a push

Branches

Branch protection rules

Default Branch

main

Branch protection rules

main
- Require a pull request before merging
  - Require approvals 1
- Require status checks to pass before merging
  - test
  - lint
- Require deployments to succeed before merging
  - review