Skip to content

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Sep 28, 2025

Problem

The architecture documentation was missing an explanation of what controls the "Required" tests that appear in GitHub PRs. Users were confused about:

  • What creates these required status checks
  • Why some tests appear as "Required" but cannot be triggered with /test
  • The relationship between Prow jobs and GitHub's branch protection

This gap was highlighted in issue #XXXXX where a user specifically asked: "Looking at the architecture document, I do not understand what controls the contents of this block in a PR on GitHub. What adds required tests? Those do not come from ProwJobs, right?"

Solution

Added a new "Required Tests and Branch Protection" section to the architecture documentation that explains:

  • Required tests are GitHub branch protection rules, not Prow jobs themselves
  • How Prow's branchprotector component can automatically configure these settings
  • The relationship between always_run: true Prow jobs and required status checks
  • Common sources of "mysterious" required tests that users cannot /test

Also added a cross-reference from the branchprotector documentation back to the architecture overview to help users understand the bigger picture.

Key clarifications provided

  1. Required tests ≠ Prow jobs - They are GitHub's enforcement of status checks
  2. Three common sources of required tests:
    • Explicit branch-protection configuration
    • Automatically derived from always_run: true Prow jobs
    • Manually set in GitHub's branch protection settings
  3. Clear path to solution - Links to branchprotector documentation for configuration details

This addresses the documentation gap identified by maintainers and provides the missing context that users need to understand Prow's integration with GitHub branch protection.

Original prompt

This section details on the original issue you should resolve

<issue_title>Missing documentation on required tests</issue_title>
<issue_description>Looking at the architecture document https://docs.prow.k8s.io/docs/overview/architecture/, I do not understand what controls the contents of this block in a PR on GitHub.

What adds required tests? Those do not come from ProwJobs, right? I have a mysterious one (pull-kubestellar-kubestellar-validate-prow-yaml) that I do not know where it is coming from (and I can not /test it).

Image</issue_description>

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

@petr-muller The items shown as `Required` are configured through GitHub's [branch protection](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) concept. That can be configured through Prow's [branchprotector](https://docs.prow.k8s.io/docs/components/optional/branchprotector/) component. The applied settings can be either origin from the explicit config, or it can be derived from Prowjob configuration - non-optional, [unconditionally triggered](https://docs.prow.k8s.io/docs/jobs/#triggering-jobs) jobs. @petr-muller Two of the links I provided lead to Prow documentation, one leads to the documentation for the component that controls the GH settings you asked about. Obviously the docs can always get better.
Fixes #451

💡 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.

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 28, 2025
@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Sep 28, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @Copilot. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Copy link

netlify bot commented Sep 28, 2025

Deploy Preview for k8s-prow ready!

Name Link
🔨 Latest commit 7044d71
🔍 Latest deploy log https://app.netlify.com/projects/k8s-prow/deploys/68d8894e0ad88200083e4caa
😎 Deploy Preview https://deploy-preview-522--k8s-prow.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 28, 2025
@k8s-ci-robot k8s-ci-robot added area/documentation Issues or PRs related to documentation labels Sep 28, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Copilot
Once this PR has been reviewed and has the lgtm label, please ask for approval from petr-muller. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

1 similar comment
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Copilot
Once this PR has been reviewed and has the lgtm label, please ask for approval from petr-muller. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 28, 2025
@Copilot Copilot AI changed the title [WIP] Missing documentation on required tests docs: Add missing documentation for required tests and branch protection Sep 28, 2025
@Copilot Copilot AI requested a review from petr-muller September 28, 2025 01:04
Copilot finished work on behalf of petr-muller September 28, 2025 01:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Issues or PRs related to documentation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing documentation on required tests

3 participants