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

docs: Add blazar project to Cosmos SDK external tooling readme section #23012

Merged
merged 2 commits into from
Dec 19, 2024

Conversation

mkaczanowski
Copy link
Contributor

@mkaczanowski mkaczanowski commented Dec 19, 2024

Description

Blazar is a standalone service designed to interact with the Cosmos SDK node, specifically handling all types of network upgrades.

It serves as an alternative to Cosmovisor with an extensive feature set, including a user interface (UI), Slack notifications, an optional SQL database for ad-hoc upgrade scheduling, and comprehensive pre- and post-upgrade checks.

You can learn more about Blazar here.

Why this Pull Request?
Blazar provides significant value to the Cosmos ecosystem by simplifying the network upgrade process for validator operators. While Cosmovisor has been a useful tool, it did not fully meet our needs at Chorus One. Consequently, we developed Blazar to address these gaps.

We believe other network operators will find Blazar to be a substantial improvement, enhancing their day-to-day operations.

Is Blazar actively maintained?
Yes, Blazar is actively maintained and used for the majority of Cosmos SDK network upgrades at Chorus One. It has been rigorously tested, both through integration and unit tests, and is regularly applied in real-world scenarios, approximately on a weekly basis.

Summary by CodeRabbit

  • Documentation
    • Updated descriptions for external tools to clarify their utility for both operations and development.
    • Added a new entry for the tool "Blazar" with a link to its GitHub repository.

@mkaczanowski mkaczanowski requested a review from a team as a code owner December 19, 2024 16:22
Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

📝 Walkthrough

Walkthrough

The pull request updates the documentation in docs/build/tooling/README.md by slightly modifying the description of external tools to emphasize their usefulness for both Cosmos SDK operations and development. A new tool, Blazar, has been added to the list of external tools with a link to its GitHub repository. The changes are minimal and focus on improving the clarity and comprehensiveness of the documentation.

Changes

File Change Summary
docs/build/tooling/README.md - Updated description of external tools to include "operations"
- Added new tool entry for Blazar with GitHub repository link

Possibly related PRs

Suggested reviewers

  • JulianToledano
  • lucaslopezf
  • facundomedica
  • akhilkumarpilli
  • cool-develope
  • tac0turtle
  • julienrbrt

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/build/tooling/README.md (1)

25-25: Consider adding a brief description for Blazar

To maintain consistency with other tools and help users understand Blazar's purpose, consider adding a brief description.

-* [Blazar](https://github.com/ChorusOne/blazar)
+* [Blazar](https://github.com/ChorusOne/blazar) - A comprehensive network upgrade management service featuring UI, notifications, and automated checks
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 69025c5 and be7db0a.

📒 Files selected for processing (1)
  • docs/build/tooling/README.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/build/tooling/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🔇 Additional comments (1)
docs/build/tooling/README.md (1)

23-23: LGTM! Description accurately reflects tool diversity

The updated description better encompasses both operational and development tools in the ecosystem.

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

super cool tooling, love the ui as well!!

@julienrbrt julienrbrt changed the title Add blazar project to Cosmos SDK external tooling readme section docs: Add blazar project to Cosmos SDK external tooling readme section Dec 19, 2024
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Technically tools like this should make it to the cosmos/awesome-cosmos repo. but ACK, is it well maintained.

@julienrbrt julienrbrt enabled auto-merge December 19, 2024 17:25
@julienrbrt julienrbrt added this pull request to the merge queue Dec 19, 2024
Merged via the queue into cosmos:main with commit 150f2d6 Dec 19, 2024
72 of 75 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants