Setup Branch Protection

To enforce a required status check for branch protection on GitHub, you must register the check by triggering it via an initial pull request, then apply a ruleset using the gh api to require that specific check on your main branch.

Setting up DataSurface PR Validator branch protection involves a two-step process: first, push a trivial file to a new branch to create a PR and register the status check, then use gh api to create a ruleset requiring the DataSurface PR Validator before merging.

Yes, you need admin access to configure GitHub branch protection rulesets. Admin privileges are required to use the gh api to create rulesets, manage GitHub Actions secrets, and enforce required status checks on the repository.

Your required status check does not appear because it must be registered first. You need to create an initial pull request that triggers the DataSurface PR Validator workflow in GitHub Actions before the check becomes available to select in branch protection rules.

Yes, you can use GitHub branch protection rulesets with the gh cli to require PR validation. The setup uses gh api to create a ruleset named Datasurface and enables the DataSurface PR Validator status check for the main branch.

Prerequisites for DataSurface model repository branch protection include having the .github/workflows/pull-request.yml file in the target repo, admin access to the repository, and configured GitHub Actions secrets for the PR validator.