Replace core-maintainers with core-team (#76)

* Replace core-maintainers with core-team Signed-off-by: Luigi Gubello <luigi@pitch.io> * Update SEC-INS and samples Signed-off-by: Luigi Gubello <luigi.gubello@gmail.com> * Add documentation for core-team Signed-off-by: Luigi Gubello <luigi.gubello@gmail.com> * Eddie review Co-authored-by: Eddie Knight <knight@linux.com> Signed-off-by: Luigi Gubello <27034386+luigigubello@users.noreply.github.com> --------- Signed-off-by: Luigi Gubello <luigi@pitch.io> Signed-off-by: Luigi Gubello <luigi.gubello@gmail.com> Signed-off-by: Luigi Gubello <27034386+luigigubello@users.noreply.github.com> Co-authored-by: Eddie Knight <knight@linux.com>
ossf · Apr 9, 2024 · 39f9d1c · 39f9d1c
1 parent be11157
commit 39f9d1c
Show file tree

Hide file tree

Showing 5 changed files with 73 additions and 10 deletions.
diff --git a/SECURITY-INSIGHTS.yml b/SECURITY-INSIGHTS.yml
@@ -8,9 +8,9 @@ header:
 project-lifecycle:
   status: active
   bug-fixes-only: false
-  core-maintainers:
-  - github:luigigubello
-  - github:eddie-knight
+  core-team:
+  - contact: github:luigigubello
+  - contact: github:eddie-knight
 contribution-policy:
   accepts-pull-requests: true
   accepts-automated-pull-requests: true

diff --git a/examples/security-insights-minimal-sample.yml b/examples/security-insights-minimal-sample.yml
@@ -5,8 +5,8 @@ header:
 project-lifecycle:
   status: active
   bug-fixes-only: false
-  core-maintainers:
-  - github:example
+  core-team:
+  - contact: github:example
 contribution-policy:
   accepts-pull-requests: true
   accepts-automated-pull-requests: true

diff --git a/examples/security-insights-sample.yml b/examples/security-insights-sample.yml
@@ -15,6 +15,11 @@ project-lifecycle:
   core-maintainers:
   - github:example
   - joe.bob@email.com
+  core-team:
+  - name: Alice White
+    contact: github:example
+  - name: Joe Dohn
+    contact: joe.bob@email.com
   release-cycle: https://foo/release
   release-process: |
       Lorem ipsum dolor sit amet, consectetur adipisci elit,

diff --git a/security-insights-schema.yaml b/security-insights-schema.yaml
@@ -69,7 +69,9 @@ properties:
                 type: boolean
             core-maintainers:
                 $id: '#/properties/project-lifecycle/properties/core-maintainers'
-                description: 'Maintainers contacts (e-mail, Twitter, etc).'
+                description: |
+                    [Deprecation notice] `core-maintainers` will be deprecated in the next versions.
+                    Maintainers contacts (e-mail, Twitter, etc).
                 additionalItems: false
                 items:
                     $id: '#/properties/project-lifecycle/properties/core-maintainers/items'
@@ -78,6 +80,41 @@ properties:
                         type: string
                 type: array
                 uniqueItems: true
+            core-team:
+                $id: '#/properties/project-lifecycle/properties/core-team'
+                description: |
+                    Maintainers or team contacts (e-mail, Mastodon, Discord, web pages, etc).
+                    Each core team member must have either a contact or a URI to a document or webpage. 
+                additionalItems: false
+                items:
+                    $id: '#/properties/project-lifecycle/properties/core-team/items'
+                    anyOf:
+                    -   $id: '#/properties/project-lifecycle/properties/core-team/items'
+                        additionalProperties: false
+                        properties:
+                            name:
+                                $id: '#/properties/project-lifecycle/properties/core-team/items/anyOf/0/properties/name'
+                                description: 'The name of the team or maintainer.'        
+                                type: string
+                            role:
+                                $id: '#/properties/project-lifecycle/properties/core-team/items/anyOf/0/properties/role'
+                                description: 'Description of the role of the team or maintainer.'
+                                type: string
+                            contact:
+                                $id: '#/properties/project-lifecycle/properties/core-team/items/anyOf/0/properties/contact'
+                                description: 'Maintainers contacts (e-mail, Twitter, etc), required if "uri" is not present.'
+                                type: string
+                            uri:
+                                $id: '#/properties/project-lifecycle/properties/core-team/items/anyOf/0/properties/uri'
+                                description: 'URI to a team document (e.g. team member page), required if "contact" is not present.'
+                                type: string
+                        oneOf:
+                        - required:
+                            - contact
+                        - required:
+                            - uri
+                type: array
+                uniqueItems: true
             roadmap:
                 $id: '#/properties/project-lifecycle/properties/roadmap'
                 description: 'Link to the project roadmap.'
@@ -106,15 +143,15 @@ properties:
                     const: "active"
         then:
             required:
-            - core-maintainers
+            - core-team
         else:
             if:
                 properties:
                     bug-fixes-only:
                         const: true
             then:
                 required:
-                - core-maintainers
+                - core-team
         required:
         - status
         - bug-fixes-only

diff --git a/specification.md b/specification.md
@@ -81,6 +81,11 @@ project-lifecycle:
   core-maintainers:
   - https://github.com/github
   - joe.bob@email.com
+  core-team:
+  - name: Alice White
+    contact: github:example
+  - name: Joe Dohn
+    contact: joe.bob@email.com
   release-cycle: https://foo/release
   release-process: |
       foo bar
@@ -89,10 +94,26 @@ project-lifecycle:
 - `bug-fixes-only` (Required)
   - **Description:** Provide the maintenance status of the project by specifying if the maintainers fix only bugs without providing new features.
   - **Type:** Boolean.
-- `core-maintainers` (Conditionally required)
+- `core-maintainers`
   - **Description:** Provide the contacts of the project maintainers (emails, social profiles, websites, etc). This information can help consumers to contact the right people.
+    - [Deprecation notice] _`core-maintainers` will be removed in v1.2.0_
   - **Type:** Array. Elements of the array are strings.
-  - **Condition:** This value is required if `bug-fixes-only` is `true` or if `status` is `active`.
+- `core-team` (Conditionally required)
+  - **Description:** Provide the contacts of the project maintainers (emails, social profiles, websites, etc) or team (web-pages, group e-mails, mailing list, etc). This information can help consumers to contact the right people.
+  - **Type:** Array.
+  - `name`
+    - **Description:** The name of the maintainer or the team.
+    - **Type:** String.
+  - `role`
+    - **Description:** Role of the maintainer in the project.
+    - **Type:** String.
+  - `contact` (Conditional required)
+    - **Description:** Contact of the maintaner or team (e.g. e-mail, Discord, mailing list, etc).
+    - **Type:** String.
+  - `uri` (Conditional required)
+    - **Description:** URI to the team page or team contact information (e.g. mail form page).
+    - **Type:** String. 
+  - **Condition:** This value `core-team` is required if `bug-fixes-only` is `true` or if `status` is `active`. At least one between `contact` and `uri` is required. 
 - `roadmap`
   - **Description:** URI to the project roadmap.
   - **Type:** String. The provided URL must meet the IRI standard (RFC 3987) and begin with `https://`.