Skip to content

Update vulnerability management and coordinated disclosure - #15

Merged
Ekhorn merged 7 commits into
mainfrom
docs/vulnerability-management-and-coordinated-disclosure
Sep 30, 2026
Merged

Ekhorn merged 7 commits into
mainfrom
docs/vulnerability-management-and-coordinated-disclosure

Conversation

@Ekhorn

@Ekhorn Ekhorn commented Sep 9, 2026 •

Copy link
Copy Markdown
Contributor

Documents the parts of 6.4 that were only in people's heads, and replaces a workaround with the built-in option.

  • One vulnerability per advisory. Cites CNA rules 4.1 and 4.2, which GitHub applies when issuing a CVE. A report with independently fixable vulnerabilities is split into one advisory per vulnerability, each with its own CVE; separate reports of the same weakness are merged with every reporter credited, and reporters are told the outcome either way.
  • Severity. Adds severity scoring is done with CVSS, with vector example and what to do when it misrepresents real world risk.
  • Merge authority unchanged, named properly. Still the product owners, now written as the openremote/product-owners team rather than the "Product Owners" group. Clarifies merge authority i.e. who can merge and why.
  • Branch-protection workaround replaced. The old instructions had the merger temporarily untick "Do not allow bypassing the above settings" and remember to re-enable it afterwards. The advisory page offers Merge and bypass branch protections directly, so the protection settings no longer have to be edited at all.
  • Local checks before merge. The fork runs no CI, so the pipeline checks have to pass locally before a fix is proposed for merge. Previously implicit.
  • Publication does not always wait for a fix. An advisory with a planned fix is published once a release containing it is public. A confirmed vulnerability that will not be fixed is published anyway, stating that no fix is planned and documenting mitigations, matching the advisory tracker, which treats that case as publishable.
  • Split into Developing the fix, Merging and Publishing, and moved the hard line breaks from trailing spaces to \. The fork mechanics are unchanged.

@Ekhorn
Ekhorn requested a review from a team September 9, 2026 15:57
@Ekhorn Ekhorn self-assigned this Sep 9, 2026
@Ekhorn Ekhorn added the Documentation Improvements or additions to documentation label Sep 9, 2026

@wborn wborn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is an initial AI-assisted review.

Two workflow inconsistencies should be resolved before merging. The handbook broadens the CVE splitting rule beyond independently fixable vulnerabilities, and its publication rule conflicts with the related advisory tracker by requiring a fixed release even though valid vulnerabilities with no planned fix are explicitly considered publishable. There is also one smaller documentation cleanup around obsolete branch-protection guidance. Details are in the inline comments.

Comment thread docs/vulnerability-management-and-coordinated-disclosure.md Outdated
Comment thread docs/vulnerability-management-and-coordinated-disclosure.md Outdated
Comment thread docs/vulnerability-management-and-coordinated-disclosure.md Outdated
@Ekhorn
Ekhorn force-pushed the docs/vulnerability-management-and-coordinated-disclosure branch from e83b16f to acea2d5 Compare September 11, 2026 13:54
@Ekhorn
Ekhorn requested a review from wborn September 11, 2026 13:56
wborn
wborn previously approved these changes Sep 14, 2026
Comment thread docs/vulnerability-management-and-coordinated-disclosure.md Outdated
Comment thread docs/vulnerability-management-and-coordinated-disclosure.md Outdated
Comment thread docs/vulnerability-management-and-coordinated-disclosure.md Outdated
@Ekhorn
Ekhorn force-pushed the docs/vulnerability-management-and-coordinated-disclosure branch from 9eeef0b to 8b31942 Compare September 25, 2026 09:46
@Ekhorn
Ekhorn requested review from ebariaux and wborn and removed request for ebariaux September 25, 2026 12:08

@wborn wborn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One minor documentation consistency issue remains around the triage terminology.

This review was AI-assisted.

Comment thread docs/vulnerability-management-and-coordinated-disclosure.md
@Ekhorn
Ekhorn requested a review from wborn September 25, 2026 14:02

@wborn wborn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM now!

@Ekhorn
Ekhorn merged commit 0bcaca7 into main Sep 30, 2026
2 checks passed
@Ekhorn
Ekhorn deleted the docs/vulnerability-management-and-coordinated-disclosure branch September 30, 2026 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants