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: correct uniond versions in docs and add upgrade history #1070

Merged

Conversation

PoisonPhang
Copy link
Contributor

@PoisonPhang PoisonPhang commented Dec 22, 2023

Summary by CodeRabbit

  • Documentation
    • Updated infrastructure and testnet documentation with version-related information and upgrade history.
  • Refactor
    • Introduced new Version.js file to dynamically return version based on parameters.
    • Modified shell commands to use the Version function for setting version-related variables.
  • Chores
    • Introduced versions variable initialized from a JSON file for improved version handling.

@PoisonPhang PoisonPhang self-assigned this Dec 22, 2023
@PoisonPhang PoisonPhang linked an issue Dec 22, 2023 that may be closed by this pull request
Copy link

coderabbitai bot commented Dec 22, 2023

Walkthrough

The changes involve the introduction of a new Version.js file providing version retrieval functionality, and the utilization of the Version function to dynamically set version-related variables across multiple documentation files. Additionally, modifications to the flake.nix file introduce a new versions variable initialized from a JSON file, enabling more dynamic version assignment.

Changes

Files Changes
docs/.../getting-started.md
docs/.../obtaining_uniond.md
Introduce import statement for Version from @site/src/components/Version and modify shell commands to use the Version function to set version-related variables dynamically.
docs/.../unionvisor.md Modify the way UNIONVISOR_VERSION is imported and used, including the addition of Version import from @site/src/components/Version.
docs/.../upgrade_history.md Add "Upgrade History" file providing a record of Union network binary upgrades, specifically detailing the upgrades for the union-testnet-4 network.
docs/src/components/Version.js New file providing a function that returns the version based on the provided chainId and genesis parameters.
flake.nix Introduce a new versions variable initialized from a JSON file, and assign the complete array the value of versions.union-testnet-4 instead of a hardcoded array.

Note

Pull Request Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://coderabbit.ai


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
  • You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging @coderabbitai in a comment. Examples:
  • You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions. Examples:
    • @coderabbitai render interesting statistics about this repository as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai generate unit tests for the src/utils.ts file.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

github-actions bot commented Dec 22, 2023

Docs Preview URL

https://docs-30f1mn9qw-unionbuild.vercel.app

benluelo
benluelo previously approved these changes Dec 22, 2023
aeryz
aeryz previously approved these changes Dec 22, 2023
@PoisonPhang PoisonPhang dismissed stale reviews from aeryz and benluelo via f05b9a9 December 22, 2023 22:11
@PoisonPhang PoisonPhang merged commit 4af5145 into main Dec 22, 2023
@PoisonPhang PoisonPhang deleted the 1068-correct-uniond-versions-in-docs-and-add-upgrade-history branch December 22, 2023 22:41
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.

Correct uniond versions in docs and add upgrade history
3 participants