[edk2-devel] [edk2-libc Patch 1/1] edk2-libc: Move to github pull request workflow

["Jayaprakash, N" <n.jayaprakash@intel.com>]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4840

Migrate data from Maintainers.txt to the GitHub standard CODEOWNERS
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 CODEOWNERS file.

Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Jayaprakash N <n.jayaprakash@intel.com>
Signed-off-by: Jayaprakash N <n.jayaprakash@intel.com>
---
 .github/workflows/AssignReviewers.yaml | 34 ++++++++++++
 CODEOWNERS                             | 21 ++++++++
 CONTRIBUTORS.md                        | 13 +++++
 Maintainers.txt                        | 71 --------------------------
 4 files changed, 68 insertions(+), 71 deletions(-)
 create mode 100644 .github/workflows/AssignReviewers.yaml
 create mode 100644 CODEOWNERS
 create mode 100644 CONTRIBUTORS.md
 delete mode 100644 Maintainers.txt

diff --git a/.github/workflows/AssignReviewers.yaml b/.github/workflows/AssignReviewers.yaml
new file mode 100644
index 0000000..4d0779e
--- /dev/null
+++ b/.github/workflows/AssignReviewers.yaml
@@ -0,0 +1,34 @@
+## @file
+# Assign reviewers from a REVIEWERS file using CODEOWNERS syntax
+#
+# Copyright (c) 2024, Intel Corporation. All rights reserved.<BR>
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+
+name: Assign reviewers from a REVIEWERS file using CODEOWNERS syntax
+
+on:
+  pull_request_target:
+    types: [opened, synchronize, reopened, ready_for_review]
+    branches:
+      - master
+
+jobs:
+  assign_reviewers:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: Generate Token
+        id: generate-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ secrets.TIANOCORE_ASSIGN_REVIEWERS_APPLICATION_ID }}
+          private-key: ${{ secrets.TIANOCORE_ASSIGN_REVIEWERS_APPLICATION_PRIVATE_KEY }}
+      - name: Checkout Pull Request Target
+        uses: actions/checkout@v2
+      - name: Assign Reviewers
+        uses: mdkinney/github-action-assign-reviewers@main
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
\ No newline at end of file
diff --git a/CODEOWNERS b/CODEOWNERS
new file mode 100644
index 0000000..f171244
--- /dev/null
+++ b/CODEOWNERS
@@ -0,0 +1,21 @@
+## @file
+# This file contains the code owners of edk2-libc repo
+#
+# Copyright (c) 2024, Intel Corporation. All rights reserved.<BR>
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+
+# This file contains the list of maintainers (i.e. people who own the
+# areas and can commit changes) for various parts of edk2-libc.
+
+# EDK II Platforms maintainers
+# ============================
+
+* @mdkinney @bcran @jpshivakavi
+
+# AppPkg owners
+AppPkg/** @mdkinney @jpshivakavi @bcran
+
+# StdLib and StdLibPrivateInternalFiles owners
+StdLib/** @mdkinney @jpshivakavi @bcran
+StdLibPrivateInternalFiles/** @mdkinney @jpshivakavi @bcran
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
new file mode 100644
index 0000000..5173898
--- /dev/null
+++ b/CONTRIBUTORS.md
@@ -0,0 +1,13 @@
+EDK II Libc Maintainers and Reviewers
+==========================================
+
+This file is intended to provide an easy way to look up people's names and email addresses given their GitHub usernames from the CODEOWNERS / REVIEWERS files.
+
+Since it's an extra file to remember to update when changing maintainers or reviewers, it will likely become out-of-sync with CODEOWNERS and/or REVIEWERS over time and need an occasional refresh.
+
+
+| Name                 | e-mail address                | Githubusername                                  |
+|----------------------|-------------------------------|-------------------------------------------------|
+| Rebecca Cran         | rebecca@bsdio.com             | [@bcran](https://github.com/bcran)              |
+| Michael D Kinney     | michael.d.kinney@intel.com    | [@mdkinney](https://github.com/mdkinney)        |
+| Jayaprakash Nevara   | n.jayaprakash@intel.com       | [@jpshivakavi](https://github.com/jpshivakavi)  |
diff --git a/Maintainers.txt b/Maintainers.txt
deleted file mode 100644
index 8a98987..0000000
--- a/Maintainers.txt
+++ /dev/null
@@ -1,71 +0,0 @@
-EDK II LIBC Project Maintainers
-===============================
-
-This file provides information about the primary maintainers for the EDK II LIBC
-Project.  This repository was exported from the edk2 repository and depends
-on the edk2 repository.  The following are the links to the edk2 repository:
-
-    https://github.com/tianocore/edk2
-    https://github.com/tianocore/edk2/blob/master/Readme.md
-    https://github.com/tianocore/edk2/blob/master/Maintainers.txt
-
-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,
-the package maintainer should send the patch to update Maintainers.txt
-with new maintainer, and the new maintainer should follow up with
-an Acked-by or a Reviewed-by.
-
-Descriptions of section entries:
-
-  L: Mailing list that is relevant to this area (default is edk2-devel)
-     Patches and questions should be sent to the email list.
-  M: Package Maintainer: Cc address for patches and questions. Responsible
-     for reviewing and pushing package changes to source control.
-  R: Package Reviewer: Cc address for patches and questions. Reviewers help
-     maintainers review code, but don't have push access. A designated Package
-     Reviewer is reasonably familiar with the Package (or some modules
-     thereof), and/or provides testing or regression testing for the Package
-     (or some modules thereof), in certain platforms and environments.
-  W: Web-page with status/info
-  T: SCM tree type and location.  Type is one of: git, svn.
-  S: Status, one of the following:
-     Supported:  Someone is actually paid to look after this.
-     Maintained: Someone actually looks after it.
-     Odd Fixes:  It has a maintainer but they don't have time to do
-                 much other than throw the odd patch in. See below.
-     Orphan:     No current maintainer [but maybe you could take the
-                 role as you write your new code].
-     Obsolete:   Old code. Something tagged obsolete generally means
-                 it has been replaced by a better system and you
-                 should be using that.
-
-EDK II LIBC Project
--------------------
-W: https://github.com/tianocore/tianocore.github.io/wiki/EDK-II
-L: https://edk2.groups.io/g/devel
-T: git - https://github.com/tianocore/edk2-libc.git
-
-Responsible Disclosure, Reporting Security Issues
--------------------------------------------------
-TBD
-
-EDK II Releases:
-----------------
-TBD
-
-EDK II Packages:
-----------------
-AppPkg
-W: https://github.com/tianocore/tianocore.github.io/wiki/AppPkg
-M: Rebecca Cran <rebecca@bsdio.com>
-M: Michael D Kinney <michael.d.kinney@intel.com>
-M: Jayaprakash N <n.jayaprakash@intel.com>
-
-StdLib, StdLibPrivateInternalFiles
-W: https://github.com/tianocore/tianocore.github.io/wiki/StdLib
-M: Rebecca Cran <rebecca@bsdio.com>
-M: Michael D Kinney <michael.d.kinney@intel.com>
-M: Jayaprakash N <n.jayaprakash@intel.com>
-- 
2.46.0.windows.1



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