Skip to content

Conversation

Copy link

Copilot AI commented Jan 27, 2026

Prevent merging broken PRs by providing a single status check that gates on all critical CI jobs.

Changes

  • Added required job to .github/workflows/ci.yaml:

    • Depends on svlint, build_and_test, riscof, and de1-soc
    • Uses if: always() to run regardless of dependency outcomes
    • Fails if any dependency failed or was cancelled (treats skipped as success)
  • Created .github/REQUIRED_CHECKS.md: Documents branch protection configuration

Usage

Configure branch protection to require the required status check. This provides a stable check name instead of tracking individual job names.

required:
  runs-on: ubuntu-latest
  if: always()
  needs:
    - svlint
    - build_and_test
    - riscof
    - de1-soc

Repository admins: mark the required check as mandatory in Settings → Branches → Branch protection rules.

Original prompt

This section details on the original issue you should resolve

<issue_title>Make CI jobs required</issue_title>
<issue_description>To make sure we don't accidentally merge broken PRs mark CI jobs as required.</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits January 27, 2026 22:51
Co-authored-by: TheDeepestSpace <11333378+TheDeepestSpace@users.noreply.github.com>
Co-authored-by: TheDeepestSpace <11333378+TheDeepestSpace@users.noreply.github.com>
Copilot AI changed the title [WIP] Make CI jobs required for merging PRs Add required CI job for branch protection Jan 27, 2026
Copilot AI requested a review from TheDeepestSpace January 27, 2026 22:55

# This job ensures all CI checks pass before allowing PR merges
# Mark this job as required in branch protection settings
required:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i thought that there was some sort a flag i can attach to a job that will mark it as required and not let me merge a PR if its not passing; i remember that such jobs has a "required" tag on them

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right that jobs marked as required in branch protection settings show a "Required" badge in the PR checks UI. However, there's no workflow-level attribute (like required: true) that automatically makes a job required - you still need to configure it in Settings → Branches → Branch protection rules.

The required job I added provides a single, stable status check name that you can mark as required in branch protection. This is the standard pattern because:

  • Individual job names can change when workflows are modified
  • A single gating job is easier to manage than multiple required checks
  • It ensures all critical jobs pass with one configuration

To enable it: Go to Settings → Branches → Add/edit rule for main → Check "Require status checks to pass" → Select the required check.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make CI jobs required

2 participants