Skip to content

Commit

Permalink
Add changelogs and tags
Browse files Browse the repository at this point in the history
  • Loading branch information
nyonson committed Oct 23, 2024
1 parent fc94b9a commit ea18098
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 4 deletions.
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
default:
@just --list

# Add a release tag and publish to the upstream remote. Need write privileges on the repository.
tag crate version remote="upstream":
# A release tag is specific to a crate so following the convention crate-version.
echo "Adding release tag {{crate}}-{{version}} and pushing to {{remote}}..."
# Annotated tag.
git tag -a {{crate}}-{{version}} -m "Release {{version}} for {{crate}}"
git push {{remote}} {{crate}}-{{version}}
5 changes: 5 additions & 0 deletions protocol/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# v0.4.0

* Adds the `AsyncProtocol` high level interface for less boilerplate integration when using an async runtime (e.g. Tokio). Codes against the `futures-rs` traits, so any runtime which is compatible with those should be supported.
* Aync read functions should now be cancellation safe.
* The high level `Io` variant of the `ProtocolError` exposes if it is worth retrying with the V1 protocol with the new `ProtocolFailureSuggestion` type.
2 changes: 1 addition & 1 deletion protocol/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "bip324"
version = "0.3.1"
version = "0.4.0"
edition = "2021"
license-file = "LICENSE"
description = "Encrypted messaging over the Bitcoin P2P Protocol as specified by BIP 324"
Expand Down
3 changes: 3 additions & 0 deletions proxy/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# v0.3.0

* The new `--v1-fallback` flag allows a proxy connection to fallback to the V1 protocol if a remote doesn't support V2.
2 changes: 1 addition & 1 deletion proxy/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "bip324-proxy"
version = "0.2.0"
version = "0.3.0"
edition = "2021"
license-file = "LICENSE"
description = "BIP324 proxy enabling v1-only clients to use the v2 Bitcoin P2P Protocol"
Expand Down

0 comments on commit ea18098

Please sign in to comment.