Re: [edk2-devel] [PATCH edk2-platforms v2 1/1] Move to the GitHub Pull Request workflow

["Rebecca Cran" <rebecca@bsdio.com>]

Replies inline.

On 8/1/24 3:45 AM, Leif Lindholm wrote:
> On Sat, Jul 27, 2024 at 14:31:56 -0600, Rebecca Cran wrote:
>> Migrate data from Maintainers.txt to the GitHub standard CODEOWNERS
>> files plus REVIEWERS and CONTRIBUTORS.md. The latter file contains
>> mappings from name to email address and GitHub usernames, which will
>> help people who want to email maintainers instead of using GitHub.
>>
>> Add .github/workflows/AssignReviewers.yml which adds reviewers to a
>> Pull Request based on the content of the REVIEWERS file.
>>
>> Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
>> ---
>>   .github/workflows/AssignReviewers.yml |  28 ++
>>   CODEOWNERS                            | 146 +++++++
>>   CONTRIBUTORS.md                       |  68 +++
>>   Maintainers.txt                       | 445 --------------------
>>   REVIEWERS                             |  92 ++++
>>   Readme.md                             |  32 +-
>>   6 files changed, 361 insertions(+), 450 deletions(-)
>>
>> diff --git a/.github/workflows/AssignReviewers.yml b/.github/workflows/AssignReviewers.yml
>> new file mode 100644
>> index 000000000000..8ee95edbb2c1
>> --- /dev/null
>> +++ b/.github/workflows/AssignReviewers.yml
>> @@ -0,0 +1,28 @@
>> +## @file
>> +# Assign reviewers from a REVIEWERS file using CODEOWNERS syntax
> If we're starting to do manual copying around of files between
> repositories, can we add a manual audit trail?
>
> I.e., full URL of repository, path inside repository, and commit hash?
>
> I think my preference would be in this file header.

I'm not sure I understand. This file came from 
https://github.com/mdkinney/github-action-assign-reviewers/blob/main/.github/workflows/AssignReviewers.yml.

Would you like me to add a note to .github/workflows/AssignReviewers.yml 
to say that's where it came from?

>> diff --git a/CODEOWNERS b/CODEOWNERS
>> new file mode 100644
>> index 000000000000..bc86dd113398
>> --- /dev/null
>> +++ b/CODEOWNERS
>> @@ -0,0 +1,146 @@
>> ...
>> +# Sophgo platforms and silicon
>> +/Platform/Sophgo/** @vlsunil
>> +/Silicon/Sophgo/SG2042Pkg/** @vlsunil
> Not super important, but if we're doing this change it would be an
> opportunity to re-sort the areas alphabetically, since that broke
> somewhere along the way.

Fixed.

>> diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
>> new file mode 100644
>> index 000000000000..84882bcab2fa
>> --- /dev/null
>> +++ b/CONTRIBUTORS.md
>> @@ -0,0 +1,68 @@
>> +EDK II Platforms Maintainers and Reviewers
>> +=========================================================
>> +
>> +This file provides information about the people who maintain and review
>> +code for EDK II Platforms. For information about who from this file
>> +maintains (i.e. owns and can commit changes) and who reviews changes in
>> +various parts of the repo, see the CODEOWNERS and REVIEWERS files.
>> +
>> +| Name                   | e-mail address                   | Github username                                      |
>> +|------------------------|----------------------------------|------------------------------------------------------|
>> +| Leif Lindholm          | quic_llindhol@quicinc.com        | [@leiflindholm](https://github.com/leiflindholm)     |
>> +| Michael D Kinney       | michael.d.kinney@intel.com       | [@mdkinney](https://github.com/mdkinney)             |
>> +| Ard Biesheuvel         | ardb+tianocore@kernel.org        | [@ardbiesheuvel](https://github.com/ardbiesheuvel)   |
>> +| Abner Chang            | abner.chang@amd.com              | [@changab](https://github.com/changab)               |
>> +| Abdul Lateef Attar     | AbdulLateef.Attar@amd.com        | [@abdattar](https://github.com/abdattar)             |
>> +| Paul Grimes            | paul.grimes@amd.com              | [@pbgrimes](https://github.com/pbgrimes)             |
>> +| Eric Xing              | eric.xing@amd.com                | [@exinghr](https://github.com/exinghr)               |
>> +| Ken Yao                | ken.yao@amd.com                  | [@YSHRong](https://github.com/YSHRong)               |
>> +| Duke Zhai              | duke.zhai@amd.com                | [@mingxzha](https://github.com/mingxzha)             |
>> +| Igniculus Fu           | igniculus.fu@amd.com             | [@fhh200000](https://github.com/fhh200000)           |
>> +| Nhi Pham               | nhi@os.amperecomputing.com       | [@nhivp](https://github.com/nhivp)                   |
>> +| Chuong Tran            | chuong@os.amperecomputing.com    | [@chuongtranle](https://github.com/chuongtranle)     |
>> +| Rebecca Cran           | rebecca@os.amperecomputing.com   | [bcran](https://github.com/bcran)                    |
>> +| Thomas Abraham         | thomas.abraham@arm.com           |                                                      |
>> +| Sami Mujawar           | sami.mujawar@arm.com             | [@samimujawar](https://github.com/)                  |
>> +| Ray Ni                 | ray.ni@intel.com                 | [@niruiyu](https://github.com/niruiyu)               |
>> +| Ilias Apalodimas       | ilias.apalodimas@linaro.org      | [@apalos](https://github.com/apalos)                 |
>> +| Wenyi Xie              | xiewenyi2@huawei.com             |                                                      |
>> +| Pedro Falcato          | pedro.falcato@gmail.com          | [@heatd](https://github.com/heatd)                   |
>> +| Marvin H??user          | mhaeuser@posteo.de               | [@mhaeuser](https://github.com/mhaeuser)             |
> Is this charset corruption only in the email?
Yes. See 
https://github.com/bcran/edk2-platforms/blob/github-pr/CONTRIBUTORS.md .
>> +| Sai Chaganty           | rangasai.v.chaganty@intel.com    | [@SaiChaganty](https://github.com/SaiChaganty)       |
>> +| Nate DeSimone          | nathaniel.l.desimone@intel.com   | [@nate-desimone](https://github.com/nate-desimone)   |
>> +| Liming Gao             | gaoliming@byosoft.com.cn         | [@lgao4](https://github.com/lgao4)                   |
>> +| Eric Dong              | eric.dong@intel.com              | [@ydong10](https://github.com/ydong10)               |
>> +| Dandan Bi              | dandan.bi@intel.com              | [@dandanbi](https://github.com/dandanbi)             |
>> +| Nickle Wang            | nicklew@nvidia.com               | [@nicklela](https://github.com/nicklela)             |
>> +| Zailiang Sun           | zailiang.sun@intel.com           | [@zailiangsun](https://github.com/zailiangsun)       |
>> +| Yi Qian                | yi.qian@intel.com                | [@yqian4](https://github.com/yqian4)                 |
>> +| Chasel Chiu            | chasel.chiu@intel.com            | [@ChaselChiu](https://github.com/ChaselChiu)         |
>> +| Benjamin Doron         | benjamin.doron00@gmail.com       | [@benjamindoron](https://github.com/benjamindoron)   |
>> +| Jeremy Soller          | jeremy@system76.com              | [@jackpot51](https://github.com/jackpot51)           |
>> +| Deepika Kethi Reddy    | deepika.kethi.reddy@intel.com    | [@dkethire](https://github.com/dkethire)             |
>> +| Kathappan Esakkithevar | kathappan.esakkithevar@intel.com | [@kesakkit](https://github.com/kesakkit)             |
>> +| Heng Luo               | heng.luo@intel.com               |                                                      |
>> +| Rosen Chuang           | rosen.chuang@intel.com           | [@rbitw](https://github.com/rbitw)                   |
>> +| Saloni Kasbekar        | saloni.kasbekar@intel.com        | [@SaloniKasbekar](https://github.com/SaloniKasbekar) |
>> +| Bob Feng               | bob.c.feng@intel.com             | [@BobCF](https://github.com/BobCF)                   |
>> +| Yuwei Chen             | yuwei.chen@intel.com             | [@YuweiChen1110](https://github.com/YuweiChen1110)   |
>> +| Sunil V L              | sunilvl@ventanamicro.com         | [@vlsunil](https://github.com/vlsunil)               |
>> +| Daniel Schaefer        | git@danielschaefer.me            | [@JohnAZoidberg](https://github.com/JohnAZoidberg)   |
>> +| Ashraf Ali S           | ashraf.ali.s@intel.com           | [@AshrafAliS](https://github.com/AshrafAliS)         |
>> +| Bibo Mao               | maobibo@loongson.cn              |                                                      |
>> +| Xianglai li            | lixianglai@loongson.cn           |                                                      |
>> +| Chao Li                | lichao@loongson.cn               |                                                      |
>> +| Marcin Wojtas          | marcin.s.wojtas@gmail.com        | [@wojtas-marcin](https://github.com/wojtas-marcin)   |
>> +| Narinder Dhillon       | ndhillon@marvell.com             | [@ndhillonm](https://github.com/ndhillonm)           |
>> +| Meenakshi Aggarwal     | meenakshi.aggarwal@nxp.com       | [@Meenakshi88](https://github.com/Meenakshi88)       |
>> +| Theo Jehl              | theojehl76@gmail.com             | [@theomacx86](https://github.com/theomacx86)         |
>> +| Marcin Juszkiewicz     | marcin.juszkiewicz@linaro.org    | [@hrw](https://github.com/hrw)                       |
>> +| Graeme Gregory         | graeme@xora.org.uk               |                                                      |
>> +| Jeremy Linton          | jeremy.linton@arm.com            | [@jlinton](https://github.com/jlinton)               |
>> +| Peng Xie               | xiepeng@phytium.com.cn           |                                                      |
>> +| Ling Jia               | jialing@phytium.com.cn           |                                                      |
>> +| Yiqi Shu               | shuyiqi@phytium.com.cn           |                                                      |
>> +| dahogn                 | dahogn@hotmail.com               | [@dahogn](https://github.com/dahogn)                 |
>> +| meng-cz                | mengcz1126@gmail.com             | [@meng-cz](https://github.com/meng-cz)               |
>> +| caiyuqing379           | caiyuqing_hz@outlook.com         | [@caiyuqing379](https://github.com/caiyuqing379)     |
>> +| USER0FISH              | libing1202@outlook.com           | [@USER0FISH](https://github.com/USER0FISH)           |
> Likewise, could we sort this alphabetically by name string?
> (If that's annoying, can you push it to a branch where I could pull it
> down and sort it?)

Done. Took about 30 seconds (column select mode, copy lines to a file, 
run through `sort`) :)

>> diff --git a/Maintainers.txt b/Maintainers.txt
>> deleted file mode 100644
>> index 824838486072..000000000000
>> --- a/Maintainers.txt
>> +++ /dev/null
>> @@ -1,445 +0,0 @@
>> ,,,
>> -Any contributions to this branch should be submitted via email to the
>> -edk2-devel mailing list with a subject prefix of `[platforms]`. See
>> -[Laszlo's excellent guide](https://github.com/tianocore/tianocore.github.io/wiki/Laszlo's-unkempt-git-guide-for-edk2-contributors-and-maintainers) for details
>> -on how to do this successfully.
>> +Any contributions to this branch should be submitted via GitHub Pull Request,
>> +or email to the edk2-devel mailing list with a subject prefix of `[platforms]`. See
>> +[Laszlo's excellent guide](https://github.com/tianocore/tianocore.github.io/wiki/Laszlo's-unkempt-git-guide-for-edk2-contributors-and-maintainers) for details on how to do this successfully.
> Can you put back this line break?
Fixed.

>> +
>> +For details of who owns code in certain parts of the repo, see the CODEOWNERS and
>> +REVIEWERS files. Look in CONTRIBUTORS.md to find out people's names and their
>> +email addresses.
>> +
>> +In general, you should not privately email the maintainer. You should
>> +email the edk2-devel list, and Cc the package maintainers and
>> +reviewers.
>> +
>> +If the package maintainer wants to hand over the role to other people,
> Strictly speaking, the maintainership areas aren't broken up on a
> package granularity here.

I've dropped the 'package' wording in favor of "area".


-- 

Rebecca


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#120172): https://edk2.groups.io/g/devel/message/120172
Mute This Topic: https://groups.io/mt/107583542/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-