Skip to content

Commit 40bb2f4

Browse files
chore: prepare Cosmovisor v0.1.0 release (#9868)
## Description Release Notes + Changelog --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [x] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
1 parent 7031589 commit 40bb2f4

File tree

3 files changed

+56
-0
lines changed

3 files changed

+56
-0
lines changed

cosmovisor/CHANGELOG.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<!--
2+
Guiding Principles:
3+
4+
Changelogs are for humans, not machines.
5+
There should be an entry for every single version.
6+
The same types of changes should be grouped.
7+
Versions and sections should be linkable.
8+
The latest version comes first.
9+
The release date of each version is displayed.
10+
Mention whether you follow Semantic Versioning.
11+
12+
Usage:
13+
14+
Change log entries are to be added to the Unreleased section under the
15+
appropriate stanza (see below). Each entry should ideally include a tag and
16+
the Github issue reference in the following format:
17+
18+
* (<tag>) \#<issue-number> message
19+
20+
The issue numbers will later be link-ified during the release process so you do
21+
not have to worry about including a link manually, but you can if you wish.
22+
23+
Types of changes (Stanzas):
24+
25+
"Features" for new features.
26+
"Improvements" for changes in existing functionality.
27+
"Deprecated" for soon-to-be removed features.
28+
"Bug Fixes" for any bug fixes.
29+
"Client Breaking" for breaking Protobuf, gRPC and REST routes used by end-users.
30+
"CLI Breaking" for breaking CLI commands.
31+
"API Breaking" for breaking exported APIs used by developers building on SDK.
32+
"State Machine Breaking" for any changes that result in a different AppState given same genesisState and txList.
33+
Ref: https://keepachangelog.com/en/1.0.0/
34+
-->
35+
36+
# Changelog
37+
38+
## v0.1 2021-08-06
39+
40+
This is the first release and we started this changelog on 2021-07-01. See the (README)[https://github.com/cosmos/cosmos-sdk/blob/release/cosmovisor/v0.1.x/cosmovisor/CHANGELOG.md] file for the full list of features.
41+
42+
## Features
43+
44+
* [\#9652](https://github.com/cosmos/cosmos-sdk/pull/9652) Add backup option for cosmovisor.

cosmovisor/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
*Note: If new versions of the application are not set up to run in-place store migrations, migrations will need to be run manually before restarting `cosmovisor` with the new binary. For this reason, we recommend applications adopt in-place store migrations.*
66

7+
## Contributing
8+
9+
Release branches has the following format `release/cosmovisor/vA.B.x`, where A and B are a number (eg: `release/cosmovisor/v0.1.x`). Releases are tagged using the following format: `cosmovisor/vA.B.C`.
10+
711
## Installation
812

913
To install `cosmovisor`, run the following command:

cosmovisor/RELEASE_NOTES.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Cosmovisor v0.1.0 Release Notes
2+
3+
This is the first tracked release of Cosmovisor. It contains the original behavior of scanning app stdin and stdout.
4+
Since the original design, this release contains one important feature: state backup. Since v0.1, by default, cosmovisor will make a state backup (`<app_directory>/data` directory). Backup will be skipped if `UNSAFE_SKIP_BACKUP=true` is set.
5+
6+
Updates to this release will be pushed to `release/cosmovisor/v0.1.x` branch.
7+
8+
Please see the [CHANGELOG](https://github.com/cosmos/cosmos-sdk/blob/release/cosmovisor/v0.1.x/cosmovisor/CHANGELOG.md) for more details.

0 commit comments

Comments
 (0)