forked from Crockan/MercuryToolbox
chore(release): prepare public source release
This commit is contained in:
+71
@@ -0,0 +1,71 @@
|
||||
# Mercury Toolbox Release Notes Template
|
||||
|
||||
Use this template when publishing a release on Gitea. Keep it short, concrete, and oriented around what changed for someone installing or upgrading the toolbox.
|
||||
|
||||
## Title
|
||||
|
||||
`Mercury Toolbox vX.Y.Z`
|
||||
|
||||
## Summary
|
||||
|
||||
One short paragraph:
|
||||
|
||||
- What kind of release this is.
|
||||
- Who should care.
|
||||
- Whether there are any rename, install, or compatibility notes.
|
||||
|
||||
Example:
|
||||
|
||||
> Mercury Toolbox vX.Y.Z focuses on local inspection and packaging polish. This release updates the hashing command surface to `mhash`, refreshes the packaged Codex skill and AI prompt assets, and keeps the Windows + PowerShell install path aligned with the current release bundle.
|
||||
|
||||
## Highlights
|
||||
|
||||
- `Command / feature:` what changed and why it matters.
|
||||
- `Command / feature:` what changed and why it matters.
|
||||
- `Packaging / docs / skills:` what changed and why it matters.
|
||||
|
||||
## Breaking Changes
|
||||
|
||||
- `Old name or behavior -> new name or behavior`
|
||||
- `Migration note`
|
||||
|
||||
If none:
|
||||
|
||||
- None.
|
||||
|
||||
## Install Or Upgrade
|
||||
|
||||
Fresh install:
|
||||
|
||||
```powershell
|
||||
pwsh -NoProfile -File .\scripts\install-toolbox.ps1
|
||||
```
|
||||
|
||||
Portable package install:
|
||||
|
||||
```powershell
|
||||
pwsh -NoProfile -File .\dist\MercuryToolbox-<host-target>-ReleaseFast\scripts\install-package-toolbox.ps1
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
- Built with: `ReleaseFast | ReleaseSize | Debug`
|
||||
- Key verification commands:
|
||||
- `cargo nextest run -p <crate> --all-features`
|
||||
- `pwsh -NoProfile -File .\scripts\check-powershell.ps1`
|
||||
- `pwsh -NoProfile -File .\scripts\generate-ai-prompt.ps1`
|
||||
- `pwsh -NoProfile -File .\scripts\generate-ai-skill.ps1`
|
||||
- `pwsh -NoProfile -File .\scripts\check-ai-prompt.ps1 -Configuration ReleaseFast -SkipBuild`
|
||||
- `pwsh -NoProfile -File .\scripts\check-ai-skill.ps1 -Configuration ReleaseFast -SkipBuild`
|
||||
- `pwsh -NoProfile -File .\scripts\package-toolbox.ps1`
|
||||
|
||||
## Assets
|
||||
|
||||
- `MercuryToolbox-<host-target>-ReleaseFast.zip`
|
||||
- Optional extra artifacts
|
||||
|
||||
## Notes For Upgraders
|
||||
|
||||
- PATH reload or shell restart note if relevant.
|
||||
- Config, skill, or naming migration note if relevant.
|
||||
- Any intentionally removed compatibility surface.
|
||||
Reference in New Issue
Block a user