-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs updates This PR updates the README and Cargo.toml with the current status of the project. This PR also adds the missing v0.2.1 changelog, as well as a small release checklist so I don't forget the release notes a third time.
- Loading branch information
1 parent
54c7105
commit 957e3c6
Showing
4 changed files
with
71 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Release Checklist | ||
|
||
The following is the release checklist for each version of `river`. | ||
|
||
* [ ] Open a PR changing the version of `river` in `Cargo.toml`, and adding a | ||
document to the `docs/release-notes` containing the major changes in | ||
this release. | ||
* [ ] Merge the PR | ||
* [ ] Locally, pull the up to date `main` branch | ||
* [ ] Tag the commit with `git tag vX.Y.Z` | ||
* [ ] Push the tag to github with `git push origin --tags` | ||
* [ ] Wait for the `cargo-dist` job to complete. | ||
* This will create the release on github | ||
* [ ] Release to crates.io using `cargo publish` | ||
* [ ] Edit the release on github, using the "Generate release notes" feature. | ||
Move the generated "What's Changed" section to the top of the release. | ||
* [ ] Announce the release in various places |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# River v0.2.1 | ||
|
||
River is a reverse proxy application written in Rust, supported as a [Prossimo Initiative], | ||
built on top of the [Pingora engine] from Cloudflare. River began development in Q1 2024, | ||
and is currently in an early developer preview state. | ||
|
||
[Prossimo Initiative]: https://www.memorysafety.org/initiative/reverse-proxy/ | ||
[Pingora engine]: https://github.com/cloudflare/pingora | ||
|
||
This announcement covers the v0.2.1 release of River. This is a minor release that | ||
switches to the v0.2.0 crates.io release of `pingora`, in order to allow for the | ||
release of `river` on crates.io. You can now find [`river` on crates.io]. | ||
|
||
[`river` on crates.io]: https://crates.io/crates/river/0.2.1 | ||
|
||
This release was led by [OneVariable UG], and sponsored by [Prossimo][Prossimo Initiative]. | ||
|
||
[OneVariable UG]: https://onevariable.com/ | ||
|
||
For installation instructions, see [the release details on GitHub]. This release includes | ||
binaries for x86_64 Linux (GNU and MUSL builds), as well as a release for aarch64 MacOS | ||
(M-series Macs). Binaries are provided, as well as an installation script. Release tooling | ||
is provided by [`cargo-dist`]. | ||
|
||
[the release details on GitHub]: https://github.com/memorysafety/river/releases/tag/v0.2.1 | ||
[`cargo-dist`]: https://github.com/axodotdev/cargo-dist | ||
|
||
## Notable features |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters