Getting Started¶
Go from zero to a released version in under five minutes.
1. Install the tool¶
dotnet tool install --global ChangeSharp.Cli
2. Initialize your project¶
cd your-project
changesharp init
This creates changesharp.json and the .changesharp/unreleased/ directory.
3. Record a change¶
changesharp new --added "Add billing API"
Every change gets its own fragment. No more editing CHANGELOG.md by hand.
4. Check what will be released¶
changesharp status
Shows pending fragments and the version bump they will trigger.
5. Release¶
changesharp release
ChangeSharp aggregates the fragments, bumps the version in your project files, updates CHANGELOG.md, and removes the consumed fragments.
What you get¶
- A
CHANGELOG.mdfollowing Keep a Changelog. - A version number following SemVer, derived from your fragments.
- No merge conflicts: each change lives in its own file (see Frictionless Workflow).
Next steps¶
- CI/CD — automate validation and release: CI/CD Integration
- Pre-releases — publish to channels per branch: Pre-releases
- Version propagation — control version files beyond
.csproj: SemVer Rules