Skip to content
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.

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

change(dev doc): Document how to change branch protection rules #7773

Merged
merged 5 commits into from
Oct 22, 2023

Conversation

teor2345
Copy link
Contributor

Motivation

This PR documents branch protection rules.

Solution

Document when we add branch protection rules, and what they do.

Review

This is a low priority developer documentation update.

Reviewer Checklist

  • Are the PR labels correct?
  • Does the code do what the ticket and PR says?
    • Does it change concurrent code, unsafe code, or consensus rules?
  • How do you know it works? Does it have tests?

@teor2345 teor2345 added A-docs Area: Documentation A-devops Area: Pipelines, CI/CD and Dockerfiles P-Low ❄️ C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG labels Oct 18, 2023
@teor2345 teor2345 self-assigned this Oct 18, 2023
@teor2345 teor2345 requested a review from a team as a code owner October 18, 2023 21:39
@teor2345 teor2345 requested review from arya2 and removed request for a team October 18, 2023 21:39
@teor2345 teor2345 changed the title change(dev doc): Document branch protection rules change(dev doc): Document how to change branch protection rules Oct 18, 2023
upbqdn
upbqdn previously approved these changes Oct 20, 2023
book/src/dev/continuous-integration.md Outdated Show resolved Hide resolved
Copy link
Member

@Mergifyio refresh

@mergify
Copy link
Contributor

mergify bot commented Oct 22, 2023

refresh

✅ Pull request refreshed

Copy link
Member

@Mergifyio queue batched

@mergify
Copy link
Contributor

mergify bot commented Oct 22, 2023

queue batched

❌ Branch protection setting 'linear history' conflicts with Mergify configuration

Branch protection setting 'linear history' works only if merge_method: squash or merge_method: rebase.

Copy link
Member

@Mergifyio requeue batched

@mergify
Copy link
Contributor

mergify bot commented Oct 22, 2023

requeue batched

❌ This pull request head commit has not been previously disembarked from queue.

Co-authored-by: Marek <mail@marek.onl>
mergify bot added a commit that referenced this pull request Oct 22, 2023
@mergify mergify bot merged commit b04cca9 into main Oct 22, 2023
70 checks passed
@mergify mergify bot deleted the branch-protection branch October 22, 2023 15:40
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought this would include actual details (and possibly screenshots) of where and how these can be changed in github. e.g from the repo go to Settings > Branches and click "Edit" on the main branch entry.

I was able to figure this out myself but I was a bit nervous clicking around unsure of what would happen...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-devops Area: Pipelines, CI/CD and Dockerfiles A-docs Area: Documentation C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants