Skip to content

docs: add draft release process (issue #583) #649

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
leepl37 wants to merge 1 commit into from
Closed

docs: add draft release process (issue #583) #649

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# LDK Node Release Process (Draft)

This document describes a **draft release process** for `ldk-node`.
It is based on the current repo setup and can be refined by maintainers.

---

## 1. Versioning
- Follow [Semantic Versioning](https://semver.org/) (MAJOR.MINOR.PATCH).
- Update the version number in `Cargo.toml` and make sure it matches the release tag.

---

## 2. Changelog
- Update `CHANGELOG.md` with all user-facing changes:
- New features
- Bug fixes
- Breaking changes
- Use consistent formatting:
- `### Added`
- `### Fixed`
- `### Changed`

---

## 3. Tagging
- Create a signed Git tag for the release:
```bash
git tag -s vX.Y.Z -m "ldk-node vX.Y.Z"
git push origin vX.Y.Z
Loading