Skip to content

Commit 6a4ed0c

Browse files
committed
add CHANGELOG and release.toml
1 parent 63340f4 commit 6a4ed0c

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
<!-- next-header -->
9+
10+
## [Unreleased] - ReleaseDate
11+
12+
### Added
13+
14+
* Implement `CompactEncoding` for:
15+
- `SocketAddrV4`
16+
- `SocketAddrV6`
17+
- `Ipv4Addr`
18+
- `Ipv6Addr`
19+
* We also implement `CompactEncoding` for `usize` as a variable width integer.
20+
The same as the JavaScript "uint" encoding
21+
22+
### Changed
23+
24+
### Removed
25+
26+
27+
28+
29+
<!-- next-url -->

release.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
pre-release-replacements = [
2+
{file="CHANGELOG.md", search="Unreleased", replace="{{version}}"},
3+
{file="CHANGELOG.md", search="\\.\\.\\.HEAD", replace="...{{tag_name}}", exactly=1},
4+
{file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}"},
5+
{file="CHANGELOG.md", search="<!-- next-header -->", replace="<!-- next-header -->\n\n## [Unreleased] - ReleaseDate\n\n### Added\n\n### Changed\n\n### Removed\n\n", exactly=1},
6+
{file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/datrs/compact-encoding/compare/{{tag_name}}...HEAD", exactly=1},
7+
]

0 commit comments

Comments
 (0)