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

ci: add update-codeownders-from-packages.yaml #1619

Merged
merged 1 commit into from
Aug 30, 2022
Merged

Conversation

kenji-miyake
Copy link
Contributor

@kenji-miyake kenji-miyake commented Aug 18, 2022

Description

To automatically set reviewers and to ensure reviews by code owners, I'd like to introduce CODEOWNERS.
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

As it's troublesome to manually maintain CODEOWNERS for each package, I propose a way to generate it from maintainers in package.xml.

We have to update maintainers before merging this.
Related: #1610

Also, I'm planning to implement this in autoware-github-actions and use it in common for all repositories.

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

@kenji-miyake
Copy link
Contributor Author

FYI @xmfcx The test results of CODEOWNERS by TIER IV:

.
├── README.md # no owner
├── full-time
│   └── README.md
├── miyake
│   └── README.md
├── saito
│   └── README.md
└── taka
    └── README.md
full-time/* @tier4/full-time-employee
miyake/* kenji.miyake@tier4.jp
saito/* @yukkysaito
taka/* @TakaHoribe

image


image


image


image


image


image


image

@xmfcx
Copy link
Contributor

xmfcx commented Aug 18, 2022

So does this give people write permissions to edit the folders they are in?

Example:

planning/behavior_path_planner takamasa.horibe@tier4.jp this is a line from the CODEOWNERS file.

Assume takamasa.horibe@tier4.jp github account isn't in any of the github teams. And not registered in our repository.

Does he gain write access to that package if he is on the CODEOWNERS list?

Edit:

Screenshot from 2022-08-18 11-46-22

Oh if he doesn't already have write access, it doesn't change anything.

@kenji-miyake
Copy link
Contributor Author

@xmfcx No, if the people listed CODEOWNERs don't have write permissions, I believe GitHub reports errors.


### Automatically generated from package.xml ###
common/autoware_ad_api_msgs isamu.takagi@tier4.jp
common/autoware_auto_common opensource@apex.ai
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@xmfcx @BonoloAWF By the way, does AWF have a common email like opensource@apex.ai?

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
@kenji-miyake kenji-miyake changed the title ci: automatically update CODEOWNERS ci: add update-codeownders-from-packages.yaml Aug 23, 2022
@kenji-miyake kenji-miyake marked this pull request as ready for review August 23, 2022 10:49
@kenji-miyake
Copy link
Contributor Author

Worked: #1671

Since this PR itself won't update CODEOWNERS (#1671 will do), I want to merge this.

@kenji-miyake kenji-miyake merged commit 5d09a63 into main Aug 30, 2022
@kenji-miyake kenji-miyake deleted the auto-gen-codeowners branch August 30, 2022 03:49
boyali referenced this pull request in boyali/autoware.universe Sep 28, 2022
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
boyali referenced this pull request in boyali/autoware.universe Oct 3, 2022
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
boyali referenced this pull request in boyali/autoware.universe Oct 3, 2022
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
yukke42 pushed a commit to tzhong518/autoware.universe that referenced this pull request Oct 14, 2022
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
boyali referenced this pull request in boyali/autoware.universe Oct 19, 2022
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants