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.

Sign up for GitHub

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

Update baseline.yaml - NEW - OSPS-DO-14 #117

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update baseline.yaml - NEW - OSPS-DO-14 #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions baseline.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,30 @@ criteria:
security_insights_value: # TODO
scorecard_probe: # TODO

- id: OSPS-DO-14
maturity_level: 3
category: Documentation
criteria: |
The project documentation MUST provide a
descriptive statement when releases or
versions are no longer supported and that
will no longer receive security updates.

This should be provided both in human and
machine-readable formats.
Comment on lines +656 to +662
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Do we mean "should" or "SHOULD" in the second sentence? If it's the "normal English 'should'", maybe we actually mean "MUST" instead? (Personally, I lean toward SHOULD, but I want to make sure I understand your intent)
  2. As a rule, I don't like the idea of multi-sentence criteria and definitely not multi-paragraph (in the <p> sense, not in the English sense). Could it be be re-written as "The project documentation MUST provide human- and machine-readable descriptive statements when releases are no longer supported and will not longer receive security updates"? (As a note, I condensed "releases or versions" to be "releases" because I'm not entirely clear that there's a meaningful distinction between the two). Or, if the intent was for having both human- and machine-readable be a strong suggestion but not a requirement, then we should move the second sentence into the implementation (which it sort of already is)

objective: |
To advertise to downstream consumers when software
has reached "End of X" [Support, Life, Maintenance, etc.].
implementation: |
Create a status check that checks the project's
version control system for support and/or lifecycle
statements. Publishing this in machine-readble
formats is preferable.
control_mappings: # TODO
security_insights_value: # TODO
scorecard_probe: #


- id: OSPS-LE-01
maturity_level: 2
category: Legal
Expand Down
Loading