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

replace : with - to avoid repo cloning issue on windows #7

Merged
merged 2 commits into from
Jul 8, 2024
Merged

Conversation

i-norden
Copy link
Contributor

@i-norden i-norden commented Jul 3, 2024

For open-ibc/ibc-app-solidity-template#87

Can attest that cloning this repo is not possible on windows prior to this change.

E.g.

git clone https://github.com/polymerdao/polymer-registry.git fails

but git clone -b ian/dev https://github.com/polymerdao/polymer-registry.git works

This change means our file names no longer match the chain-id format convention in https://chainagnostic.org/CAIPs/caip-2 but I think that is okay because the same output is produced in dist/output.json. The clientMap is left unchanged as well, still mapping to ids using the caip-2 convention.

@i-norden i-norden requested a review from tmsdkeys July 3, 2024 23:09
Copy link

coderabbitai bot commented Jul 3, 2024

Walkthrough

The recent updates primarily address corrections to file naming conventions in various scripts and configuration file paths, switching from colon (:) to hyphen (-). This change impacts references to Base Sepolia testnet eip155:84532.json files across multiple scripts and documentation, ensuring consistency and avoiding potential issues related to file handling.

Changes

File Path Change Summary
README.md Updated filename reference from eip155:84532.json to eip155-84532.json.
utils/buildOutput.js Modified file check condition to use eip155- instead of eip155:.
utils/findConnectionHops.js Updated configuration file paths by replacing : with -, and made minor whitespace adjustments.
utils/getPortID.js Corrected file path format in the require statement within the getConfig function.

Sequence Diagram(s)

File Checking Process (Before and After Update)

sequenceDiagram
    participant User
    participant Script
    participant FileSystem

    User->>Script: Run processFiles
    Script->>FileSystem: Check for file "eip155-*.json"
    FileSystem-->>Script: File found/not found
    Script-->>User: Processed file list
Loading

Connection Hops (Before and After Update)

sequenceDiagram
    participant App
    participant findConnectionHops
    participant ConfigFiles

    App->>findConnectionHops: getConnectionHops(source, destination)
    findConnectionHops->>ConfigFiles: Load srcConfigPath
    findConnectionHops->>ConfigFiles: Load destConfigPath
    ConfigFiles-->>findConnectionHops: Return configurations
    findConnectionHops-->>App: Return connection hops
Loading

Poem

In files, a rename, so precise,
From colons to dashes, oh so nice. 🌟
Paths now clear, no longer astray,
Our scripts chirp, "Hip hip, hurray!" 🍃
Connections found with utmost ease,
Code Rabbit's heart so filled with peace. 🥕

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

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

@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

Outside diff range and nitpick comments (3)
utils/findConnectionHops.js (3)

21-21: Minor whitespace adjustment.

The whitespace adjustment improves readability.

- function getConnectionHops (source, destination) {
+ function getConnectionHops(source, destination) {

24-24: Minor whitespace adjustment.

The whitespace adjustment improves readability.

- const proofsConHops = [srcConfig.polymer.clients['op-client'].canonConnFrom, destConfig.polymer.clients['op-client'].canonConnTo];
+ const proofsConHops = [srcConfig.polymer.clients['op-client'].canonConnFrom, destConfig.polymer.clients['op-client'].canonConnTo];

53-53: Minor whitespace adjustment.

The whitespace adjustment improves readability.

- };
+};
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f1283ab and 92923fd.

Files selected for processing (4)
  • README.md (1 hunks)
  • utils/buildOutput.js (1 hunks)
  • utils/findConnectionHops.js (3 hunks)
  • utils/getPortID.js (1 hunks)
Files skipped from review due to trivial changes (2)
  • README.md
  • utils/getPortID.js
Additional comments not posted (2)
utils/buildOutput.js (1)

20-20: Correct filename condition to avoid Windows cloning issues.

The condition to check filenames has been updated to use eip155- instead of eip155:. This change aligns with the new naming convention and resolves the issue with Windows cloning.

utils/findConnectionHops.js (1)

10-10: Correct file path format to avoid Windows cloning issues.

The paths for configuration files have been updated to use hyphens instead of colons. This change aligns with the new naming convention and resolves the issue with Windows cloning.

@i-norden i-norden self-assigned this Jul 8, 2024
@i-norden i-norden merged commit 303b15f into main Jul 8, 2024
@mvpoyatt mvpoyatt deleted the ian/dev branch October 2, 2024 21:24
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.

2 participants