Required status checks in Git - Commands & Configuration

Introduction

When working with teams on code, you want to make sure that certain tests or checks pass before merging changes. Required status checks help by blocking merges until these checks succeed, keeping the code safe and stable.

When you want to ensure all automated tests pass before merging a feature branch.

When you need to enforce code review approvals before allowing merges.

When you want to prevent broken code from entering the main branch.

When multiple team members contribute and you want consistent quality control.

When using continuous integration tools that report build or test results.

Commands

Push your feature branch to the remote repository so that status checks can run on it.

Terminal

git push origin feature-branch

Expected Output

Enumerating objects: 5, done.

Counting objects: 100% (5/5), done.

Delta compression using up to 8 threads

Compressing objects: 100% (3/3), done.

Writing objects: 100% (3/3), 350 bytes | 350.00 KiB/s, done.

Total 3 (delta 2), reused 0 (delta 0)

remote: Resolving deltas: 100% (2/2), completed with 2 local objects.

To https://github.com/example/repo.git

   abc1234..def5678  feature-branch -> feature-branch

Check the current branch and status locally before creating a pull request.

Terminal

git status

Expected Output

On branch feature-branch

Your branch is up to date with 'origin/feature-branch'.

nothing to commit, working tree clean

Create a pull request on GitHub from your feature branch to the main branch. This triggers required status checks configured on the repository.

Terminal

gh pr create --title "Add new feature" --body "This adds a new feature with tests."

Expected Output

Creating pull request for feature-branch into main

https://github.com/example/repo/pull/42

→

--title - Sets the pull request title

→

--body - Adds a description to the pull request

View the status of required checks on pull request number 42 to see if all tests have passed.

Terminal

gh pr checks 42

Expected Output

Check suite for PR #42

✔️ build

✔️ test

✔️ lint

All required status checks have passed.

Key Concept

If you remember nothing else from this pattern, remember: required status checks stop code from merging until all tests and reviews pass, protecting your main branch.

Common Mistakes

Pushing code without creating a pull request to trigger status checks.

Status checks only run on pull requests, so skipping this step means no checks run.

Always create a pull request after pushing your branch to start the checks.

Ignoring failed status checks and merging anyway.

This can introduce broken or untested code into the main branch.

Wait for all required checks to pass before merging.

Not configuring required status checks in the repository settings.

Without configuration, checks won't block merges even if they run.

Set required status checks in the repository settings on GitHub or your Git server.

Summary

Push your feature branch to the remote repository to start the process.

Create a pull request to trigger required status checks like tests and builds.

Use commands to check the status of these checks before merging.

Required status checks help keep your main branch stable and error-free.

Practice

1.

What is the main purpose of required status checks in GitHub branch protection?

easy

A. To automatically delete branches after merging

B. To prevent merging if tests or checks fail

C. To allow anyone to push directly to the branch

D. To create new branches automatically

Solution

1. Step 1: Understand what required status checks do

   They stop merging pull requests if tests or checks fail, ensuring code quality.

2. Step 2: Identify the main goal in branch protection

   The goal is to keep the main branch stable by blocking merges that fail checks.

3. Final Answer:

   To prevent merging if tests or checks fail -> Option B

4. Quick Check:

   Required status checks = prevent bad merges [OK]

Hint: Required status checks block merges if tests fail [OK]

Common Mistakes:

• Thinking they delete branches automatically
• Believing they allow direct pushes without review
• Confusing with branch creation features

2.

Which of the following is the correct way to enable required status checks in GitHub?

Settings > Branches > Branch protection rules > Add rule > Require status checks to pass before merging

easy

A. Settings > Security > Enable required checks

B. Settings > Actions > Workflows > Enable status checks

C. Settings > Branches > Branch protection rules > Add rule > Require status checks to pass before merging

D. Settings > Pull requests > Require reviews

Solution

1. Step 1: Locate where branch protection rules are set

   Branch protection rules are found under Settings > Branches in GitHub repository.

2. Step 2: Identify the correct path to enable required status checks

   Within branch protection rules, you add a rule and select 'Require status checks to pass before merging'.

3. Final Answer:

   Settings > Branches > Branch protection rules > Add rule > Require status checks to pass before merging -> Option C

4. Quick Check:

   Enable checks via branch protection rules [OK]

Hint: Enable checks in branch protection rules settings [OK]

Common Mistakes:

• Looking under Actions or Security instead of Branches
• Confusing status checks with pull request reviews
• Selecting unrelated settings paths

3.

Given a branch protection rule with required status checks enabled for ci/test and ci/lint, what happens if a pull request has ci/test passing but ci/lint failing?

medium

A. The pull request can be merged because one check passed

B. The pull request is closed without merging

C. The pull request is merged automatically ignoring checks

D. The pull request cannot be merged because one required check failed

Solution

1. Step 1: Understand required status checks behavior

   All required status checks must pass before merging is allowed.

2. Step 2: Analyze the given checks results

   Since ci/lint failed, the pull request cannot be merged despite ci/test passing.

3. Final Answer:

   The pull request cannot be merged because one required check failed -> Option D

4. Quick Check:

   All required checks must pass to merge [OK]

Hint: All required checks must pass to merge PR [OK]

Common Mistakes:

• Assuming one passing check is enough
• Thinking failed checks are ignored
• Believing PR closes automatically on failure

4.

You set required status checks in branch protection, but pull requests are still merging even when checks fail. What is the most likely cause?

medium

A. Required status checks are not selected in the branch protection rule

B. The repository has no branches

C. The checks are passing but showing as failed by mistake

D. The pull request is from the default branch

Solution

1. Step 1: Verify branch protection rule settings

   Required status checks must be explicitly selected in the branch protection rule to enforce them.

2. Step 2: Understand why PRs merge despite failures

   If required checks are not selected, GitHub does not block merges even if checks fail.

3. Final Answer:

   Required status checks are not selected in the branch protection rule -> Option A

4. Quick Check:

   Check if required checks are enabled in protection rules [OK]

Hint: Enable required checks explicitly in branch protection [OK]

Common Mistakes:

• Assuming checks auto-enable without selection
• Thinking repository branch count affects checks
• Confusing default branch with PR source branch

5.

You want to ensure that pull requests cannot be merged unless both ci/build and ci/test pass, but also want to allow admins to override this if needed. How should you configure the branch protection?

hard

A. Enable required status checks for ci/build and ci/test, and allow admin overrides

B. Enable required status checks for ci/build only, no admin override

C. Disable required status checks and require pull request reviews

D. Enable required status checks and disable admin overrides

Solution

1. Step 1: Set required status checks for both ci/build and ci/test

   Both checks must be selected to block merges unless both pass.

2. Step 2: Allow admin overrides in branch protection settings

   This option lets admins merge even if checks fail, providing flexibility.

3. Final Answer:

   Enable required status checks for ci/build and ci/test, and allow admin overrides -> Option A

4. Quick Check:

   Required checks + admin override = Enable required status checks for ci/build and ci/test, and allow admin overrides [OK]

Hint: Select checks and enable admin override in protection rules [OK]

Common Mistakes:

• Selecting only one check instead of both
• Disabling admin override when override is needed
• Confusing pull request reviews with status checks