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.

Sign up for GitHub

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

Jump to bottom

docs: clarify cosmovisor doc #18359

Merged
merged 2 commits into from
Nov 6, 2023
Merged

docs: clarify cosmovisor doc #18359

merged 2 commits into from
Nov 6, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Nov 5, 2023 •
edited
Loading

Description

Closes: #18270

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
  • run make lint and make test
  • 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)

Summary by CodeRabbit

  • Documentation
    • Enhanced clarity on the purpose of cosmovisor.
    • Updated the folder layout description.
    • Added a new section detailing how to add upgrade binaries, including a SimApp upgrade example.

@julienrbrt julienrbrt requested a review from a team as a code owner November 5, 2023 21:45
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 5, 2023 •
edited
Loading

Walkthrough

The changes to the cosmovisor documentation provide a clearer understanding of its purpose and usage. The updates include a more detailed folder layout, instructions on adding upgrade binaries, and an illustrative example of a SimApp upgrade.

Changes

File Summary
tools/cosmovisor/README.md The purpose of cosmovisor is clarified, the folder layout is updated, a new section on adding upgrade binaries is added, and an example of a SimApp upgrade is provided.

🐇🍂

As autumn leaves fall, we code and tweak,

In the world of Cosmos, it's upgrades we seek.

With cosmovisor our guide, no mountain too steep,

We automate, we innovate, in binary heaps.

So here's to the changes, to progress we cheer,

In the spirit of the season, we conquer our fear.

As the moon shines bright, and the stars appear,

We code on, CodeRabbit, with nothing to fear. 🌙💻🎉

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

@github-prbot github-prbot requested review from a team, kocubinski and likhita-809 and removed request for a team November 5, 2023 21:45
@github-actions github-actions bot added the C:Cosmovisor Issues and PR related to Cosmovisor label Nov 5, 2023
coderabbitai[bot]
coderabbitai bot reviewed Nov 5, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9c2f464 and 3ab33ca.
Files selected for processing (1)
  • tools/cosmovisor/README.md (5 hunks)
Files skipped from review due to trivial changes (1)
  • tools/cosmovisor/README.md

coderabbitai[bot]
coderabbitai bot reviewed Nov 5, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3ab33ca and 1f7dec5.
Files selected for processing (1)
  • tools/cosmovisor/README.md (5 hunks)
Files skipped from review due to trivial changes (1)
  • tools/cosmovisor/README.md

@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Nov 6, 2023
@julienrbrt julienrbrt added this pull request to the merge queue Nov 6, 2023
Merged via the queue into main with commit 8b666b6 Nov 6, 2023
54 of 55 checks passed
@julienrbrt julienrbrt deleted the julien/cosmovisor branch November 6, 2023 08:30
@julienrbrt
Copy link
Member Author

julienrbrt commented Nov 6, 2023 •
edited
Loading

I am backporting this to release/v0.50.x branch, but it would be great that the whole https://docs.cosmos.network/main/build/tooling/* on release branches (/v0.50, /v0.47, etc..) simply redirects to main.

Tools are tagged from main, so it makes more sense. cc @samricotta

mergify bot pushed a commit that referenced this pull request Nov 6, 2023
@julienrbrt @mergify
docs: clarify cosmovisor doc (#18359)
d5cdcfe 
(cherry picked from commit 8b666b6)

# Conflicts:
#	tools/cosmovisor/README.md
@mergify mergify bot mentioned this pull request Nov 6, 2023
Merged
julienrbrt added a commit that referenced this pull request Nov 6, 2023
@mergify @julienrbrt
docs: clarify cosmovisor doc (backport #18359) (#18370)
57637f7 
Co-authored-by: Julien Robert <[email protected]>
@faddat faddat mentioned this pull request Nov 8, 2024
Closed
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@likhita-809 likhita-809 likhita-809 approved these changes

@tac0turtle tac0turtle tac0turtle approved these changes

@kocubinski kocubinski Awaiting requested review from kocubinski

Assignees
No one assigned
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C:Cosmovisor Issues and PR related to Cosmovisor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Documentation]: Cosmovisors abstract is misleading
3 participants
@julienrbrt @tac0turtle @likhita-809