-
Notifications
You must be signed in to change notification settings - Fork 159
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: changelog for v0.5.0 and a release checklist (#2302)
- Loading branch information
Showing
5 changed files
with
64 additions
and
5 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
28 changes: 28 additions & 0 deletions
28
documentation/developer_documentation/RELEASE_CHECKLIST.md
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 @@ | ||
Forest follows a fixed, quarterly release schedule. On the last week of each | ||
quarter, a new version is always released. This is supplemented with additional | ||
releases for bug fixes and special features. A "release officer" is appointed | ||
for each release and they are responsible for either following the checklist or, | ||
in case of absense, passing the task to a different team member. | ||
|
||
1. Update the CHANGELOG.md file to reflect all changes and preferably write a | ||
small summary about the most notable updates. The changelog should follow the | ||
design philosophy outlined here: https://keepachangelog.com/en/1.0.0/. Go | ||
through the output of `git log` and remember that the audience of the | ||
CHANGELOG does not have intimate knowledge of the Forest code-base. All the | ||
changed/updated/removed features should be reasonably understandable to an | ||
end-user. | ||
2. Update that version of the crates that are to be released. Forest contains | ||
many crates so you may need to update many Cargo.toml files. If you're | ||
working on a patch release, make sure that there are no breaking changes. | ||
Cherry-picking of patches may be necessary. | ||
3. Run the manual tests steps outlined in the TEST_PLAN.md. Caveat: Right now | ||
there are no manual test steps so this step can be skipped. | ||
4. Once the changes in step 1 and step 2 have been merged, tag the commit with | ||
the new version number. The version tag should start with a lowercase 'v'. | ||
Example: v0.4.1 | ||
5. (NOT YET APPLICABLE) Publish new crates on crates.io. | ||
6. Go to https://github.com/ChainSafe/forest/releases/new and create a new | ||
release. Use the tag created in step 4, follow the title convention of the | ||
previous releases, and write a small summary of the release (similar or | ||
identical to the summary in the CHANGELOG.md file). | ||
7. Verify that the new release contains assets for both Linux and MacOS. |
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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[package] | ||
name = "forest-cli" | ||
version = "0.4.1" | ||
version = "0.5.0" | ||
authors = ["ChainSafe Systems <[email protected]>"] | ||
description = "Filecoin implementation in Rust. This crate contains all the subcommands except the daemon." | ||
edition = "2021" | ||
|
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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[package] | ||
name = "forest-daemon" | ||
version = "0.4.1" | ||
version = "0.5.0" | ||
authors = ["ChainSafe Systems <[email protected]>"] | ||
description = "Filecoin implementation in Rust. This command will start the daemon process." | ||
edition = "2021" | ||
|