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

Replace core-maintainers with core-team #76

Merged
merged 4 commits into from
Apr 9, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions SECURITY-INSIGHTS.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/security-insights-minimal-sample.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions examples/security-insights-sample.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
43 changes: 40 additions & 3 deletions security-insights-schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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.'
Expand Down Expand Up @@ -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
Expand Down
26 changes: 23 additions & 3 deletions specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -89,10 +94,25 @@ 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)
- **Description:** Provide the contacts of the project maintainers (emails, social profiles, websites, etc). This information can help consumers to contact the right people.
- `core-maintainers`
- **Description:** [Deprecation notice] _`core-maintainers` will be deprecated in the next versions._ Provide the contacts of the project maintainers (emails, social profiles, websites, etc). This information can help consumers to contact the right people.
luigigubello marked this conversation as resolved.
Show resolved Hide resolved
- **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://`.
Expand Down