Page MenuHomeFreeBSD

Add revision history section to SA/EN template
Needs RevisionPublic

Authored by emaste on Aug 18 2022, 6:55 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, May 8, 8:52 PM
Unknown Object (File)
Dec 28 2023, 4:36 PM
Unknown Object (File)
Dec 20 2023, 6:38 AM
Unknown Object (File)
Nov 6 2023, 5:25 AM
Unknown Object (File)
Oct 5 2023, 4:08 AM
Unknown Object (File)
Sep 27 2023, 8:23 PM
Unknown Object (File)
Sep 11 2023, 8:14 AM
Unknown Object (File)
Aug 18 2023, 4:43 PM
Subscribers

Details

Reviewers
markj
delphij
gordon
Group Reviewers
secteam

Diff Detail

Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

emaste created this revision.

And drop roman numerals, they're needlessly obtuse. May make the "1) To update your system via a binary patch:" confusing, but IMO that section should also be reworked.

markj added a subscriber: markj.

I'm not wholly convinced we should add a timeline to EN notices. ENs are really their own thing, we just happen to distribute them together with SAs. Better to avoid adding more friction to EN handling. OTOH, I guess a typical timeline would have two entries: one for the initial report, one for the release, so it's not too bad.

This revision is now accepted and ready to land.Aug 18 2022, 6:58 PM
This revision now requires review to proceed.Aug 18 2022, 7:04 PM
gordon requested changes to this revision.Aug 22 2022, 2:59 PM
gordon added a subscriber: gordon.

Do we really need a revision history for every EN/SA despite the fact 95% of them will just have the "initial revision"?

website/static/security/advisory-template.txt
25

How about just dropping the Revision History line item and if/when needed, we just put it before the background in a headerless section?

website/static/security/errata-template.txt
25

Same as above

This revision now requires changes to proceed.Aug 22 2022, 2:59 PM
website/static/security/advisory-template.txt
25

Other major vendors do not publish revision history (usually they have a "updated" date, if some changes were made after the bulletin is initially published).

Note that tools have improved quite a bit since the last template change too (for example, we can easily add a link to the revisions of the advisory file so those who really want to see the difference can get the information there), therefore, removing the whole section in favor of using the Announced header sounds reasonable to me.