Skip to content

docs: mark the repo pre-release; add SECURITY.md and root LICENSE - #243

Merged
dfcoffin merged 1 commit into
mainfrom
docs/prerelease-status-security-license
Nov 14, 2026
Merged

dfcoffin merged 1 commit into
mainfrom
docs/prerelease-status-security-license

Conversation

@dfcoffin

Copy link
Copy Markdown
Contributor

Summary

The repo stays public while it is pre-release; this makes that status explicit and gives reporters a private channel.

  • README
  • SECURITY.md: report privately through Security → Report a vulnerability (private vulnerability reporting is already enabled on the repo). Covers what to expect (acknowledgement target of 5 business days, private advisory fork, CVE on publication, credit) and scope.
  • LICENSE: the Apache-2.0 text each module already ships, now at the root. GitHub currently reports the repo's license as null, and the README's ./LICENSE link was broken.

Test plan

  • Root LICENSE is byte-identical to openespi-*/LICENSE (same MD5)
  • README no longer contains Production, 3.5, helm, MIGRATION_STATUS or docs/ links

🤖 Generated with Claude Code

- README: pre-release warning banner pointing vulnerability reports to
  SECURITY.md; the module table no longer claims "Production" and now lists
  openespi-handoff and the real per-module status (#232, #89, deferred
  writes). The deployment section describes the current Spring Boot JARs,
  actuator health and build-image (no WAR, no Helm charts exist), and the
  documentation links point at files that exist.
- SECURITY.md: private reporting through GitHub security advisories, what to
  expect, scope.
- LICENSE: the Apache-2.0 text already shipped in each module, at the root, so
  GitHub detects the licence (it reported none) and README's ./LICENSE link
  resolves.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dfcoffin
dfcoffin merged commit 977620e into main Nov 14, 2026
11 checks passed
@dfcoffin
dfcoffin deleted the docs/prerelease-status-security-license branch November 14, 2026 17:59
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