Skip to content

Commit 635d7f4

Browse files
committed
feat: add changelogs
1 parent 8b1a75b commit 635d7f4

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
9+
## [0.1.0] - 2024-10-08
10+
11+
Initial release.
12+
13+
[Unreleased]: https://github.com/developmentseed/cql-rs/compare/v0.1.0...main
14+
[0.1.0]: https://github.com/developmentseed/cql-rs/releases/tag/v0.1.0

RELEASING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Releasing
2+
3+
Setup:
4+
5+
- Install [cargo-release](https://github.com/crate-ci/cargo-release): `cargo install cargo-release`
6+
7+
Then:
8+
9+
1. Create a new branch: `release/vX.Y.Z`
10+
2. Update the versions all `Cargo.toml` files, as necessary
11+
3. Update each README
12+
4. Update each CHANGELOG
13+
5. Open a PR
14+
6. Once approved, merge the PR
15+
7. (if releasing the main crate) Run `cargo release -p cql2`, then `cargo release -p cql2 --execute`
16+
8. (if releasing the cli crate) run `cargo release -p cql2-cli`, then `cargo release -p cql2-cli --execute`

cli/CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
9+
## [0.1.0] - 2024-10-08
10+
11+
Initial release.
12+
13+
[Unreleased]: https://github.com/developmentseed/cql-rs/compare/v0.1.0...main
14+
[0.1.0]: https://github.com/developmentseed/cql-rs/releases/tag/v0.1.0

0 commit comments

Comments
 (0)