Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cosmovisor): add install disclaimer and config command #15361

Merged
merged 5 commits into from
Mar 12, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Mar 12, 2023

Description

ref #15360 (comment)
ref #15362 (comment)


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...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • 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 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)

@julienrbrt julienrbrt requested a review from a team as a code owner March 12, 2023 11:48
@github-actions github-actions bot added the C:Cosmovisor Issues and PR related to Cosmovisor label Mar 12, 2023
@julienrbrt julienrbrt changed the title docs: add disclaimer in cosmovisor docs feat(cosmovisor): add install disclaimer and config command Mar 12, 2023
@@ -36,6 +36,10 @@ Ref: https://keepachangelog.com/en/1.0.0/

## [Unreleased]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Time to release a new version of cosmovisor after having done some testing I think.
I will do that next week.


*Note: If you are using go `v1.15` or earlier, you will need to use `go get`, and you may want to run the command outside a project directory.*
:::warning
Building from source using `make cosmovisor` won't display the correct `cosmovisor` version.
Copy link
Member

@tac0turtle tac0turtle Mar 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could we include the version in the binary the same way we do in the sdk?

export VERSION := $(shell echo $(shell git describe --always --match "v*") | sed 's/^v//')

Copy link
Member Author

@julienrbrt julienrbrt Mar 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we do that with ldflags, then it won't show when using go install.
Given it's the way to install our tooling, it makes more sense that it is the way that works.

@julienrbrt julienrbrt merged commit 4c1e6a5 into main Mar 12, 2023
@julienrbrt julienrbrt deleted the julien/docs-cosmovisor branch March 12, 2023 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Cosmovisor Issues and PR related to Cosmovisor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants