✨ branch protection: requiring PRs gives partial credit #3499

diogoteles08 · 2023-09-20T15:27:33Z

What kind of change does this PR introduce?

It's a feature, described on the corresponding issue

PR title follows the guidelines defined in our pull request documentation

Which issue(s) this PR fixes

Notes for the reviewers

I tried to split the PR on independent commits, so it might be easier to review commit by commit.

The last commit were just refactors on the previously existent code of the file I worked on. Let me know if you prefer that I make the refactors as another PR.

Does this PR introduce a user-facing change?

Branch Protection check now also evaluates if the project requires PRs prior to make changes to the branch. This won't change anything for the users that already require reviews, but will enable score enhancement for those who can't require reviewers.

codecov · 2023-09-20T23:21:30Z

Codecov Report

Merging #3499 (f78b2f0) into main (30ef6b1) will decrease coverage by 5.26%.
The diff coverage is 79.16%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3499      +/-   ##
==========================================
- Coverage   76.24%   70.99%   -5.26%     
==========================================
  Files         214      214              
  Lines       14625    14628       +3     
==========================================
- Hits        11151    10385     -766     
- Misses       2807     3623     +816     
+ Partials      667      620      -47

spencerschrock · 2023-09-27T15:38:24Z

Can you rebase/merge in the changes from main before review? #3502 introduced some scoring changes, so you'll need to resolve the merge conflict.

clients/githubrepo/branches.go

Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

…on when they dont contribute for clarification Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

…s-only-through-pr

spencerschrock

overall I think this is good. There's 1-2 bugs that should be fixed before merge.

checks/evaluation/branch_protection.go

checks/evaluation/branch_protection_test.go

clients/githubrepo/branches.go

e2e/branch_protection_test.go

Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

…th its purpose I also changed the test to not require PRs, as it's how it is when a new GitHub Branch Protection config is created. The changes on the loggings numbers are due to: 1. A warning for not having DismissStaleReviews became a debug 2. Removed the warning we had for not requiring CodeOwners 3. Have a new warning for not requiring PRe Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

Signed-off-by: Spencer Schrock <sschrock@google.com>

…s-only-through-pr Signed-off-by: Spencer Schrock <sschrock@google.com>

diogoteles08 requested review from azeemshaikh38, justaugustus, laurentsimon, naveensrinivasan, spencerschrock and raghavkaul as code owners September 20, 2023 15:27

diogoteles08 had a problem deploying to gitlab September 20, 2023 15:27 — with GitHub Actions Failure

diogoteles08 had a problem deploying to integration-test September 20, 2023 15:28 — with GitHub Actions Failure

diogoteles08 force-pushed the feat/branch-protection-recognize-rule-changes-only-through-pr branch from 4b17d60 to 5f53749 Compare September 20, 2023 16:40

diogoteles08 had a problem deploying to gitlab September 20, 2023 16:41 — with GitHub Actions Failure

diogoteles08 had a problem deploying to integration-test September 20, 2023 16:41 — with GitHub Actions Failure

diogoteles08 marked this pull request as draft September 20, 2023 16:47

diogoteles08 force-pushed the feat/branch-protection-recognize-rule-changes-only-through-pr branch from 5f53749 to a7ca2b5 Compare September 20, 2023 23:06

diogoteles08 had a problem deploying to gitlab September 20, 2023 23:06 — with GitHub Actions Failure

diogoteles08 had a problem deploying to integration-test September 20, 2023 23:06 — with GitHub Actions Failure

diogoteles08 force-pushed the feat/branch-protection-recognize-rule-changes-only-through-pr branch from a7ca2b5 to 657fc4f Compare September 20, 2023 23:18

diogoteles08 temporarily deployed to gitlab September 20, 2023 23:18 — with GitHub Actions Inactive

diogoteles08 temporarily deployed to integration-test September 20, 2023 23:18 — with GitHub Actions Inactive

diogoteles08 force-pushed the feat/branch-protection-recognize-rule-changes-only-through-pr branch from 657fc4f to b6778c2 Compare September 20, 2023 23:32

diogoteles08 temporarily deployed to gitlab September 20, 2023 23:33 — with GitHub Actions Inactive

diogoteles08 marked this pull request as ready for review September 20, 2023 23:33

diogoteles08 temporarily deployed to integration-test September 20, 2023 23:33 — with GitHub Actions Inactive

diogoteles08 force-pushed the feat/branch-protection-recognize-rule-changes-only-through-pr branch from b6778c2 to dae8813 Compare September 27, 2023 18:11

diogoteles08 temporarily deployed to gitlab September 27, 2023 18:11 — with GitHub Actions Inactive

diogoteles08 temporarily deployed to integration-test September 27, 2023 18:12 — with GitHub Actions Inactive

diogoteles08 force-pushed the feat/branch-protection-recognize-rule-changes-only-through-pr branch from dae8813 to d170f83 Compare September 27, 2023 18:50

diogoteles08 temporarily deployed to gitlab September 27, 2023 18:50 — with GitHub Actions Inactive

diogoteles08 temporarily deployed to integration-test September 27, 2023 18:50 — with GitHub Actions Inactive

diogoteles08 temporarily deployed to gitlab December 6, 2023 22:18 — with GitHub Actions Inactive

diogoteles08 temporarily deployed to integration-test December 6, 2023 22:18 — with GitHub Actions Inactive

pnacht reviewed Dec 7, 2023

View reviewed changes

clients/githubrepo/branches.go Outdated Show resolved Hide resolved

clients/githubrepo/branches.go Outdated Show resolved Hide resolved

clients/githubrepo/branches.go Outdated Show resolved Hide resolved

diogoteles08 added 4 commits December 8, 2023 19:14

refactor(branch-protection): use enums to represent tiers

20ba242

Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

refactor(branch-protection): remove nil fields of struct initializati…

1dd2bbd

…on when they dont contribute for clarification Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

refactor(branch-protection): simplify functions by using generics

31b6e31

Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

docs(branch-protection): update docs after generate-docs run

fbe061f

Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

diogoteles08 temporarily deployed to gitlab December 8, 2023 20:38 — with GitHub Actions Inactive

diogoteles08 temporarily deployed to integration-test December 8, 2023 20:38 — with GitHub Actions Inactive

fix(branch-protection): fix duplicated line on code

a6e27c4

Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

diogoteles08 temporarily deployed to gitlab December 8, 2023 23:14 — with GitHub Actions Inactive

diogoteles08 temporarily deployed to integration-test December 8, 2023 23:14 — with GitHub Actions Inactive

Merge branch 'main' into feat/branch-protection-recognize-rule-change…

def3081

…s-only-through-pr

diogoteles08 temporarily deployed to gitlab December 8, 2023 23:23 — with GitHub Actions Inactive

diogoteles08 temporarily deployed to integration-test December 8, 2023 23:24 — with GitHub Actions Inactive

spencerschrock approved these changes Dec 9, 2023

View reviewed changes

diogoteles08 added 3 commits December 11, 2023 13:21

fix(branch-protection): stop exporting Tier enum

131cadf

Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

refactor(branch-protection): changing unchanged var to const

7a0dc73

Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com>

diogoteles08 temporarily deployed to gitlab December 11, 2023 15:30 — with GitHub Actions Inactive

diogoteles08 temporarily deployed to integration-test December 11, 2023 15:30 — with GitHub Actions Inactive

spencerschrock added 2 commits December 11, 2023 16:34

fix e2e-pat tests

fd5b663

Signed-off-by: Spencer Schrock <sschrock@google.com>

Merge branch 'main' into feat/branch-protection-recognize-rule-change…

f78b2f0

…s-only-through-pr Signed-off-by: Spencer Schrock <sschrock@google.com>

spencerschrock temporarily deployed to gitlab December 12, 2023 06:20 — with GitHub Actions Inactive

spencerschrock temporarily deployed to integration-test December 12, 2023 06:21 — with GitHub Actions Inactive

spencerschrock changed the title ~~✨ Feat/branch protection recognize rule changes only through pr~~ ✨ branch protection: requiring PRs gives partial credit Dec 12, 2023

spencerschrock merged commit db7b6e7 into ossf:main Dec 12, 2023
41 checks passed

spencerschrock mentioned this pull request Dec 12, 2023

🐛 revert making RequiredPullRequestReviews a pointer #3728

Merged

2 tasks

This was referenced Feb 16, 2024

🌱 refactor: reorder functions to enhance readability #3880

Closed

🌱 refactor: reorder branch protection tests progressively by tier #3881

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ branch protection: requiring PRs gives partial credit #3499

✨ branch protection: requiring PRs gives partial credit #3499

diogoteles08 commented Sep 20, 2023 •

edited

Loading

codecov bot commented Sep 20, 2023 •

edited

Loading

spencerschrock commented Sep 27, 2023

spencerschrock left a comment

✨ branch protection: requiring PRs gives partial credit #3499

✨ branch protection: requiring PRs gives partial credit #3499

Conversation

diogoteles08 commented Sep 20, 2023 • edited Loading

What kind of change does this PR introduce?

Which issue(s) this PR fixes

Notes for the reviewers

Does this PR introduce a user-facing change?

codecov bot commented Sep 20, 2023 • edited Loading

Codecov Report

spencerschrock commented Sep 27, 2023

spencerschrock left a comment

Choose a reason for hiding this comment

diogoteles08 commented Sep 20, 2023 •

edited

Loading

codecov bot commented Sep 20, 2023 •

edited

Loading