forked from paradigmxyz/reth
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: crude release workflow doc (paradigmxyz#284)
* docs: crude release workflow checklist * docs: add changelog The changelog format is based on [Keep a Changelog][kac] and can be somewhat automated. [kac]: https://keepachangelog.com/en/1.0.0/
- Loading branch information
Showing
3 changed files
with
29 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
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). | ||
|
||
<!-- next-header --> | ||
|
||
## [Unreleased] | ||
|
||
Initial release. | ||
|
||
<!-- next-url !--> | ||
[Unreleased]: https://github.com/foundry-rs/reth/compare/978527367f159ff3d9f90723e73cf2560c8f54b8...HEAD |
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,14 @@ | ||
## Release Workflow | ||
|
||
1. Update the version in `Cargo.toml` | ||
2. Update the changelog[^1] | ||
- Check that all issues marked https://github.com/foundry-rs/reth/labels/M-changelog have been added to the changelog | ||
- Move the "Unreleased" section in the changelog under a new header with the new version, and fix up the links in the bottom of the file | ||
3. Ensure tests and lints pass | ||
4. Commit the new changelog and version bump | ||
5. Tag the new version (no `v` prefix) | ||
6. Push the new commit and tag | ||
7. (Run release command)[^2] | ||
|
||
[^1]: This can be automated somewhat. | ||
[^2]: TBD. |