Skip to content

Add info about how sync between Gitbox and GH works #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add info about how sync between Gitbox and GH works #79

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc2b98b
docs: add more information about branch protection sync between GH an…
sparsick Aug 6, 2025
ede8ec7
docs: adjust after review
sparsick Aug 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,7 @@ We will evaluate the need for other autolink features.
<h3 id="branchpro">Branch protection</h3>

Projects can enable branch protection in their repos, including most of the sub-level protection features such as 'require status checks to pass before merging' , 'approval by at least $n people' , and 'require pull request reviews'. There are no default protections.
All GitHub branch protection rules are also enforced when pushing directly to ASF Gitbox.
For more details on Branch Protection Rules in general, please refer to the [documentation @ GitHub](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches).

> [!WARNING]
Expand Down Expand Up @@ -453,7 +454,14 @@ required_status_checks:

**Notes**
1. Enabling any of the above checks overrides what you may have set previously, so you'll need to add all the existing checks to your `.asf.yaml` file to reproduce any that Infra set manually for you.
2. If you need to remove a required check in order to push a change to `.asf.yaml`, create an Infra Jira ticket with a request to have the check manually removed.
2. These checks also are observed by Gitbox.
3. If you need to remove a required check in order to push a change to `.asf.yaml`, create an Infra Jira ticket with a request to have the check manually removed.

> [!NOTE]
> **How the synchronization between Gitbox and GitHub works under the hood**
>
> When you push to Gitbox, we handle all the synchronization in the Git update phase, which means GitHub is asked for each commit inside that push whether it is allowed.
> If as much as a single commit is disallowed, the sync process reverts and you get an error message explaining what went wrong.

Using the 'contexts' list will automatically set an app ID of `-1` (any source) for checks. If you wish to specify a specific source app ID, you can make use of the expanded `checks` list instead:

Expand Down