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

Ensure changes to repo level source-build files are code reviewed by source-build experts #3435

Closed
26 tasks done
MichaelSimons opened this issue May 11, 2023 · 12 comments
Closed
26 tasks done
Assignees

Comments

@MichaelSimons
Copy link
Member

MichaelSimons commented May 11, 2023

Here is an example change that should have been reviewed by a source-build expert. The changes to the SourceBuildPrebuiltBaseline.xml caused prebuilts to be added and weren't caught until internal source-build CI.

Suggestions:

  1. Add comments to the repo level source-build files to promote having a source-build expert code review any changes
  2. If a repo has a CODEOWNERS file, assign ownership of the repo level source-build files to the source-build team to ensure they get included in code reviews.

Repos with comments only:

Repos with both the comments and CODEOWNERS entry:

@dotnet-issue-labeler
Copy link

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

@MichaelSimons
Copy link
Member Author

This is an example of a change we should be reviewing. These prebuilts should have been added to SBRP.

@MichaelSimons
Copy link
Member Author

@oleksandr-didyk - FYI, It looks like a few repos are missing from the tracking list. There are 26 repos that participate in source-build.

@oleksandr-didyk
Copy link
Contributor

@oleksandr-didyk - FYI, It looks like a few repos are missing from the tracking list. There are 26 repos that participate in source-build.

The list contains 24 + I omitted SBRP and externals as changes to them would get reviewed by us anyways. With them its 26, or did I miss some?

@MichaelSimons
Copy link
Member Author

@oleksandr-didyk - FYI, It looks like a few repos are missing from the tracking list. There are 26 repos that participate in source-build.

The list contains 24 + I omitted SBRP and externals as changes to them would get reviewed by us anyways. With them its 26, or did I miss some?

IMO we should still update the two source-build repos for reference purposes (referring to the comments at the top of the source-build files, not CODEOWNERS). Our repos are a reference for others to see how to implement source-build.

@oleksandr-didyk
Copy link
Contributor

IMO we should still update the two source-build repos for reference purposes (referring to the comments at the top of the source-build files, not CODEOWNERS). Our repos are a reference for others to see how to implement source-build.

Sure thing, will add them

@oleksandr-didyk
Copy link
Contributor

oleksandr-didyk commented Jun 1, 2023

@MichaelSimons something I forgot to ask - if a team is added to CODEOWNERS they need to have explicit write access to the repository.

Is it worth asking the repo maintainers for this for the 2 files we currently have?

akoeplinger pushed a commit to dotnet/emsdk that referenced this issue Jun 1, 2023
Contributes to dotnet/source-build#3435

Adds comments to source-build files asking for the inclusion of the source-build team in PRs that alter `SourceBuild*` files. Non-reviewed changes could potentially cause issues down the line, be it in the downstream repos or the product build (as has happened in the past, see dotnet/source-build#3435 (comment))
@MichaelSimons
Copy link
Member Author

Is it worth asking the repo maintainers for this for the 2 files we currently have?

[Triage] - We feel like that we should try and get access if repo owners are willing as this is the best way to ensure source-build experts are included in code reviews. If there is resistance/pushback, then we will drop the request to change CODEOWNERS.

@MichaelSimons
Copy link
Member Author

FYI - It appears that you cannot grant access or mention teams cross organization boundaries. So repos like vstest that reside in the Microsoft organization can't assign source-build-internal as a CODEOWNER.

@mthalman
Copy link
Member

mthalman commented Jun 1, 2023

FYI - It appears that you cannot grant access or mention teams cross organization boundaries. So repos like vstest that reside in the Microsoft organization can't assign source-build-internal as a CODEOWNER.

In that case, I suppose we could use individual usernames instead?

@MichaelSimons
Copy link
Member Author

In that case, I suppose we could use individual usernames instead?

I have thought about it but it is a maintenance concern and opted not to for now. Let's see how effective the comment is. If it remains a problem then we should use individuals.

JaynieBai pushed a commit to dotnet/msbuild that referenced this issue Jun 6, 2023
Context
Contributes to dotnet/source-build#3435

Adds comments to source-build files asking for the inclusion of the source-build team in PRs that alter SourceBuild* files. Non-reviewed changes could potentially cause issues down the line, be it in the downstream repos or the product build (as has happened in the past, see dotnet/source-build#3435 (comment))

Changes Made
added comments to source-build files asking for the inclusion of the source-build team in PRs that alter SourceBuild* file.
hoyosjs added a commit to dotnet/diagnostics that referenced this issue Jun 8, 2023
Contributes to dotnet/source-build#3435

Adds comments to source-build files asking for the inclusion of the
source-build team in PRs that alter `SourceBuild*` files. Non-reviewed
changes could potentially cause issues down the line, be it in the
downstream repos or the product build (as has happened in the past, see
dotnet/source-build#3435 (comment))

Add ownership restrictions to files.
---------

Co-authored-by: Juan Hoyos <[email protected]>
@oleksandr-didyk
Copy link
Contributor

SourceBuild* files in all 26 repos have the comment review added; where possible entries to CODEOWNERS for applicable files has been added

Closing as done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

3 participants