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

bugfix in types action #885

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

bugfix in types action #885

wants to merge 2 commits into from

Conversation

0xDEnYO
Copy link
Contributor

@0xDEnYO 0xDEnYO commented Nov 28, 2024

Which Jira task belongs to this PR?

Why did I implement it this way?

The action that generates types was failing as it was not correctly adding deleted files to git staging.
The new code changes this behaviour

Checklist before requesting a review

  • I have performed a self-review of my code
  • This pull request is as small as possible and only tackles one problem
  • I have added tests that cover the functionality / test the bug
  • I have updated any required documentation

Checklist for reviewer (DO NOT DEPLOY and contracts BEFORE CHECKING THIS!!!)

  • I have checked that any arbitrary calls to external contracts are validated and or restricted
  • I have checked that any privileged calls (i.e. storage modifications) are validated and or restricted
  • I have ensured that any new contracts have had AT A MINIMUM 1 preliminary audit conducted on by <company/auditor>

Copy link
Contributor

coderabbitai bot commented Nov 28, 2024

Walkthrough

The pull request includes modifications to the workflow file .github/workflows/types.yaml, aimed at improving functionality and error handling for generating TypeScript bindings. Key changes involve updating the copying process for generated types, adding a debugging step to verify file status, modifying the tag-pushing step to stage all changes, and refining error handling for retrieving the latest tag. These enhancements collectively aim to increase the robustness of the workflow.

Changes

File Change Summary
.github/workflows/types.yaml - Updated the copy command for generated types to cp -r typechain/* and ensured the destination directory is created if it does not exist.
- Added a debugging step to run git status in the lifi-contract-types directory after copying types.
- Modified the tag-pushing step to use git add -A to stage all changes, ensuring all modifications are included.
- Enhanced error handling for retrieving the latest tag, including checks for empty values and improved validation of semantic versioning format.

Possibly related PRs

  • fix types action (test) #879: This PR modifies the .github/workflows/types.yaml file, focusing on enhancing the version tagging process and error handling, which aligns closely with the changes made in the main PR.

Suggested labels

AuditNotRequired

Suggested reviewers

  • ezynda3
  • Matt-LiFi

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.

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

@lifi-action-bot lifi-action-bot marked this pull request as draft November 28, 2024 01:43
@0xDEnYO 0xDEnYO marked this pull request as ready for review November 28, 2024 01:43
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

🧹 Outside diff range and nitpick comments (2)
.github/workflows/types.yaml (2)

65-69: Enhance debug step visibility.

While adding git status debugging is helpful, consider making the output more visible and informative.

 - name: Verify File Status (for debugging)
   run: |
     cd lifi-contract-types
+    echo "=== BEGIN FILE STATUS ==="
     git status
+    echo "=== END FILE STATUS ==="
+    echo "=== BEGIN DIRECTORY STRUCTURE ==="
+    ls -la
+    echo "=== END DIRECTORY STRUCTURE ==="

Line range hint 3-4: Optimize workflow trigger conditions.

The workflow currently runs on all pushes. Consider adding path filters to run only when relevant files change.

 on:
   push:
+    paths:
+      - 'src/**'
+      - 'contracts/**'
+      - 'package.json'
+      - '.github/workflows/types.yaml'
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 207f863 and 6ff9454.

📒 Files selected for processing (1)
  • .github/workflows/types.yaml (2 hunks)
🔇 Additional comments (2)
.github/workflows/types.yaml (2)

60-62: LGTM! Clean directory management approach.

The sequence of operations (remove, create, then copy) is correct and uses appropriate flags (-p for mkdir).


176-180: Improved git staging approach.

Replacing individual git add commands with git add -A is more robust as it:

  1. Captures all changes including deletions
  2. Ensures no files are accidentally missed
  3. Maintains consistency between the working directory and the commit

@0xDEnYO 0xDEnYO changed the title bugfix bugfix in types action Nov 28, 2024
@lifi-action-bot
Copy link
Collaborator

lifi-action-bot commented Nov 28, 2024

Test Coverage Report

Line Coverage: 76.59% (1725 / 2252 lines)
Function Coverage: 83.10% ( 364 / 438 functions)
Branch Coverage: 36.21% ( 197 / 544 branches)
Test coverage (76.59%) is above min threshold (76%). Check passed.

@0xDEnYO 0xDEnYO enabled auto-merge (squash) November 28, 2024 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants