Skip to content

Commit

Permalink
docs: crude release workflow doc (paradigmxyz#284)
Browse files Browse the repository at this point in the history
* 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
onbjerg committed Nov 30, 2022
1 parent 480097a commit b7a2951
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
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
1 change: 1 addition & 0 deletions docs/repo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
Documents on planning and process in the repository: what the labels mean, how issues are triaged, how a new release is cut and so on.

- [Labels](./labels.md): Describes the labels in the repository.
- [Release workflow](./release.md): Describes the release workflow for maintainers.

### Structure

Expand Down
14 changes: 14 additions & 0 deletions docs/repo/release.md
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.

0 comments on commit b7a2951

Please sign in to comment.