Skip to content

Commit

Permalink
docs(cosmovisor): fix typo in installation instructions (cosmos#17038)
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt authored Jul 18, 2023
1 parent 1236c52 commit 9ba6b72
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 4 deletions.
4 changes: 2 additions & 2 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ The Cosmos-SDK follows both [0ver](https://0ver.org/) and [Semver](https://semve
Although we adhere to semantic versioning (semver), we have introduced a few modifications to accommodate the unique characteristics of blockchains. One significant divergence is that the major version (Y.x.x) is incremented solely when a consensus-breaking change occurs. On the other hand, the minor version (x.Y.x) is increased when there is a non-consensus-breaking alteration that also results in an incompatible API change. Patch versions will be bumped for all other changes that dont break the API nor Consensus.

<p align="center">
<img src="semver.png?raw=true" alt="Releases Semver decision tree" width="40%" />
<img src="docs/static/img/semver.png?raw=true" alt="Releases Semver decision tree" width="40%" />
</p>

## 0ver Dependencies

In terms of the Cosmos-SDK dependency, we adhere to a simpler versioning approach known as 0ver. This flow differs from the previous Semver flow. Under this system, when a consensus-breaking change or an API-breaking change occurs, the Cosmos-SDK team increments the minor version (x.Y.x). Conversely, when a non-consensus-breaking change and a non-API-breaking change take place, the team bumps the patch version (x.x.Y).

<p align="center">
<img src="0ver.png?raw=true" alt="Releases 0ver decision tree" width="40%" />
<img src="docs/static/img/0ver.png?raw=true" alt="Releases 0ver decision tree" width="40%" />
</p>
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions tools/cosmovisor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ To install the latest version of `cosmovisor`, run the following command:
go install cosmossdk.io/tools/cosmovisor/cmd/cosmovisor@latest
```

To install a previous version, you can specify the version:
To install a specific version, you can specify the version:

```shell
go install github.com/cosmos/cosmos-sdk/cosmovisor/cmd/[email protected]
go install cosmossdk.io/tools/cosmovisor/cmd/[email protected]
```

Run `cosmovisor version` to check the cosmovisor version.
Expand Down
6 changes: 6 additions & 0 deletions tools/cosmovisor/RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Cosmovisor v1.5.0 Release Notes

See the [CHANGELOG](https://github.com/cosmos/cosmos-sdk/blob/tools/cosmovisor/v1.5.0/tools/cosmovisor/CHANGELOG.md) for details on the changes in v1.5.0.

## Installation instructions

```go
go install cosmossdk.io/tools/cosmovisor/cmd/cosmovisor@latest
```

0 comments on commit 9ba6b72

Please sign in to comment.