Skip to content

State the support period and add a user information document - #132

Merged
Gorka Gonzalo (d0ubl3g) merged 1 commit into
devfrom
docs/support-period-user-info
Oct 11, 2026
Merged

Gorka Gonzalo (d0ubl3g) merged 1 commit into
devfrom
docs/support-period-user-info

Conversation

@d0ubl3g

Copy link
Copy Markdown
Contributor

Documentation only.

  • SECURITY.md, Supported versions: replaces "Only the latest release receives fixes" with the support rule. From 1.0.0, each major version is supported with security fixes for five years, counted from its first version, and fixes ship in the latest release of that major version. While 0.x is current, fixes go into the latest 0.x release, and 0.x has no end-of-support date until 1.0.0 is released. Security fixes stay available after a HodeiShield subscription ends, since installing or updating never requires one. An end-of-support notice is published twelve months ahead in SECURITY.md, the README's security notice block and the release notes.
  • docs/user-information.md (new): one place for the product and version identification, the manufacturer and its contact details, the point of contact for vulnerabilities, the intended purpose, security properties and secure use, known limitations, the support period, how to update through each install channel and turn off the new-version notice, how to remove the CLI and everything it stores, and where the software bill of materials is published and that it is intended for users. Each release's copy is the one in its tag.
  • README.md: one sentence on the support rule and a link to the new document.
  • CHANGELOG.md: one sentence added to the documentation entry in Unreleased.

Refs #127, #128

SECURITY.md "Supported versions" replaces "only the latest release
receives fixes" with the support rule: from 1.0.0, each major version
is supported with security fixes for five years, delivered in the
latest release of that major version; fixes stay available to people
whose HodeiShield subscription has ended, since releases are public
downloads. During 0.x, fixes go into the latest 0.x release, and 0.x
has no end-of-support date until 1.0.0 is released. An end-of-support
notice is published twelve months ahead in SECURITY.md, the README
security notice block and the release notes.

docs/user-information.md gathers the product and version
identification, the manufacturer's address and contact, the two ways
to report a vulnerability, the intended purpose, secure use and known
limitations, how each install channel updates and uninstalls, how to
turn off the new-version notice, how to remove the configuration,
update-check record and keychain entries, and where the SBOM is
published. Each release tag keeps the copy that applies to it.

The README links to both and states the rule in one sentence.

Refs #127
Refs #128

Signed-off-by: d0ubl3g <48954024+d0ubl3g@users.noreply.github.com>
@d0ubl3g
Gorka Gonzalo (d0ubl3g) merged commit be063e4 into dev Oct 11, 2026
13 checks passed
@d0ubl3g
Gorka Gonzalo (d0ubl3g) deleted the docs/support-period-user-info branch October 11, 2026 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant