Required status checks in Git - Mini Project: Build & Apply

Configure Required Status Checks in Git

📖 Scenario: You are working on a team project using Git. To keep the main branch stable, your team wants to make sure that certain checks pass before any code can be merged. These checks include running tests and code style checks.

🎯 Goal: You will create a simple Git repository, add a configuration file to specify required status checks, and verify that the checks are set up correctly.

📋 What You'll Learn

Create a Git repository named project-repo

Add a file named status-checks.config with required checks listed

Use a variable required_checks to hold the list of checks

Print the list of required checks to confirm the setup

💡 Why This Matters

🌍 Real World

Teams use required status checks to ensure code quality and prevent broken code from entering important branches.

💼 Career

Understanding how to configure and verify required status checks is important for roles like DevOps engineer, release manager, and software developer.

1

Create a Git repository

Create a Git repository named project-repo by running git init project-repo.

Git

# Run the command to create the repository
# Your code here

Hint

Use the git init command followed by the repository name.

2

Add a status checks configuration file

Inside the project-repo folder, create a file named status-checks.config with these exact lines:
tests
lint
build

Git

# Create the file status-checks.config with the required checks listed
# Your code here

Hint

Use echo with newline characters to write multiple lines to the file.

3

Create a variable for required checks

Create a variable called required_checks that reads the lines from project-repo/status-checks.config into a list.

Git

# Read the file lines into required_checks variable
# Your code here

Hint

Use command substitution with $(cat filename) to read file content into a variable.

4

Print the required status checks

Print the value of the required_checks variable to display the list of required status checks.

Git

# Print the required_checks variable
# Your code here

Hint

Use printf "%s\n" "$required_checks" to print the content preserving newlines.

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