Skip to content

Commit 1c2bf56

Browse files
authored
chore: preparing for v2 release (#100)
* chore: preparing for v2 release
1 parent 24b147d commit 1c2bf56

15 files changed

+78
-96
lines changed
File renamed without changes.

.github/security-insights.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
header:
2+
schema-version: 1.0.0
3+
last-updated: '2021-09-01'
4+
last-reviewed: '2022-09-01'
5+
url: https://github.com/ossf/security-insights-spec
6+
comment: This file contains the security information for the Security Insights project.
7+
8+
project:
9+
name: Security Insights
10+
administrators:
11+
- name: Christopher Robinson
12+
affiliation: Linux Foundation
13+
primary: true
14+
repositories:
15+
- name: Security Insights
16+
url: https://github.com/ossf/security-insights-spec
17+
comment: |
18+
Security Insights is the core repo for the Security Insights project.
19+
vulnerability-reporting:
20+
reports-accepted: true
21+
bug-bounty-available: false
22+
23+
repository:
24+
status: active
25+
url: https://github.com/ossf/security-insights-spec
26+
accepts-change-request: true
27+
accepts-automated-change-request: false
28+
no-third-party-packages: true
29+
core-team:
30+
- name: Eddie Knight
31+
affiliation: Sonatype
32+
primary: true
33+
license:
34+
url: https://github.com/ossf/security-insights-spec/blob/main/LICENSE
35+
expression: MIT AND Community Specification License 1.0
36+
security:
37+
assessments:
38+
self:
39+
evidence: https://github.com/ossf/security-insights-spec/blob/main/docs/threat-model
40+
comment: |
41+
A light-weight threat model was completed when the project was first started,
42+
and it remains accurate to-date.
43+
documentation:
44+
contributing-guide: https://github.com/ossf/security-insights-spec/blob/main/.github/CONTRIBUTING.md
45+
governance: https://github.com/ossf/security-insights-spec/blob/main/docs/GOVERNANCE.md
46+
release:
47+
automated-pipeleine: false
48+
distribution-points:
49+
- uri: https://github.com/ossf/security-insights-spec/releases
50+
comment: GitHub Release Page

CONTRIBUTING.md

-29
This file was deleted.

README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,25 @@ This specification provides a mechanism for projects to report information about
66

77
The data tracked within this specification is intended to fill the gaps between simplified solutions such as `SECURITY.md` and comprehensive automatable solutions such as SBOMs. In that gap lay elements that must be self-reported by projects to allow end-users to make informed security decisions.
88

9+
## Usage
10+
11+
Projects should include a `security-insights.yml` file in the root of their repository, or in the appropriate source forge directory such as `.github/` or `.gitlab/`. Users should assume the contents of that file will be updated any time the relevant information changes.
12+
13+
To ensure you are adhering to an official version of the specification, please refer to the `specification.md` in the [latest release](https://github.com/ossf/security-insights/releases/latest), which is a versioned compilation of all details.
14+
15+
This repository often remains unchanged from the latest release, but may diverge as incremental development takes place in preparation for an upcoming release. Any differences between the latest release and the main branch should only be considered previews of the next release.
16+
917
As the adoption of Security Insights grows, so does the opportunity to automatically ingest it. For example, the Linux Foundation's [CLOMonitor](https://clomonitor.io/) parses a project's Security Insights file to determine whether projects have reported on select security factors prioritized by the foundation.
1018

11-
All information regarding the maintenance, security, and consumption of the Security Insights Specification can be found in this repo within the latest version of the [official specification file](/specification.md).
19+
## Maintenance
20+
21+
The specification maintenance occurs in the following places:
22+
23+
- `specification/`: Contains markdown details for all specification values
24+
- `schema.cue`: Contains the CUE schema that can be used to validate files against the specification
25+
- `template-full.yml`: Contains a template that includes all possible fields
26+
- `template-minimal.yml`: Contains a template that includes only the required fields
27+
28+
Discussion and feedback should take place in [GitHub Issues](https://github.com/ossf/security-insights/issues).
1229

13-
Please use GitHub issues to discuss the maintenance of this specification, and review the [Contributor Guidelines](./CONTRIBUTING.md) for more information.
30+
Because this specification recieves light maintenance and infrequent updates, beginning in 2025 we ask that you follow the [Security Insights Enhancement Proposal](./docs/GOVERNANCE.md#security-insights-enhancement-proposals) process to explore potential changes to the specification.

SECURITY-INSIGHTS.yml

-49
This file was deleted.

SECURITY.md

-7
This file was deleted.

GOVERNANCE.md docs/GOVERNANCE.md

File renamed without changes.

MAINTAINERS.md docs/MAINTAINERS.md

File renamed without changes.

schema.cue

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ import (
1616
}
1717

1818
#Attestation: {
19-
name: string
20-
location: #URL
21-
"predicate-uri": string
19+
name: string
20+
location: #URL
21+
"predicate-uri": string
2222
comment?: string
2323
}
2424

specification-details/aliases.md specification/aliases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Aliases
1+
# Aliases _(v2.0.0)_
22

33
The following aliases are used throughout the schema for consistency.
44

specification-details/header.md specification/header.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `header`
1+
# `header` _(v2.0.0)_
22

33
The `header` object captures high-level metadata about the schema.
44

specification-details/project.md specification/project.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `project`
1+
# `project` _(v2.0.0)_
22

33
The `project` object describes the overall project, including basic info, documentation links, repositories, vulnerability reporting, and security details.
44

specification-details/repository.md specification/repository.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `repository`
1+
# `repository` _(v2.0.0)_
22

33
The `repository` object specifies repository-related configurations, including status, policies, team members, documentation, license, releases, and security posture.
44

template-full.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
header:
2-
schema-version: 1.0.0
2+
schema-version: 2.0.0
33
last-updated: '2021-09-01'
44
last-reviewed: '2022-09-01'
55
url: https://foo.bar/foo/bar

template-minimum.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
header:
2-
schema-version: 1.0.0
2+
schema-version: 2.0.0
33
last-updated: '2021-09-01'
44
last-reviewed: '2022-09-01'
55
url: https://foo.bar/kubernetes/kubernetes

0 commit comments

Comments
 (0)