Blackcap Release Notes
Blackcap release notes summarize meaningful customer- and System Admin-facing changes in intentionally published releases. They are maintained as part of Blackcap's canonical documentation and are written deliberately after a substantial body of work is ready to communicate.
Release notes are not generated automatically from Git commits, development conversations, or raw issue lists. A release may ship without a published release-note entry while Blackcap remains under active alpha development. The presence or absence of release notes never controls update eligibility, package validation, installation, or rollback.
Release-note structure
When a release note is published, use the Blackcap application version as the primary identity and include the seven-character Git SHA when release provenance is known:
## vX.Y.Z (abcdef1)
The full Git SHA may be included once in release metadata when technical traceability is useful. Do not repeat it on every change item.
Use only the sections that contain meaningful information:
- New โ newly available user or administrator capabilities.
- Improved โ meaningful usability, performance, reliability, or workflow improvements.
- Fixed โ defects corrected in the release that are useful for users or administrators to know about.
- Security โ relevant security hardening or security-impacting fixes that are appropriate to disclose.
- Deployment / Upgrade Notes โ manual actions, compatibility considerations, migrations, or operational details that matter when moving to the release.
- Known Issues โ important limitations that remain in the release.
Keep entries concise and outcome-focused. Internal refactors, test-only changes, generated-file changes, and implementation details normally belong in development history rather than customer release notes.
Publishing workflow
At the end of a substantial Blackcap improvement cycle:
- Decide whether the accumulated changes are meaningful enough to publish as a release note.
- Confirm the version and exact release Git SHA that the note describes.
- Summarize the user-visible and operational changes rather than copying commit messages.
- Add only the applicable sections from the structure above.
- Call out any deployment action or known issue that a System Admin needs before applying the release.
- Keep older published entries unchanged except for factual corrections.
The System โ Blackcap Updates panel links to this canonical page. When version-specific release entries begin to be published, their headings provide stable destinations that can be referenced directly without tying documentation to temporary package artifacts.
Release entry template
Use this template when the first deliberate release note is ready to publish:
## vX.Y.Z (abcdef1)
**Released:** YYYY-MM-DD
**Full Git SHA:** `<40-character SHA>`
### New
- ...
### Improved
- ...
### Fixed
- ...
### Security
- ...
### Deployment / Upgrade Notes
- ...
### Known Issues
- ...
Remove any empty section before publishing. The release date and full SHA are optional when they are not useful for the intended audience.
Published releases
No deliberate Blackcap release-note entries have been published yet. This section will begin when a release is intentionally selected for customer-facing notes.