search

zeta-chain / protocol-contracts

Protocol contracts implementing the core logic of the protocol, deployed on ZetaChain and on connected chains
MIT License
68 stars 55 forks source link

ci: publish v2 #297

Closed fadeev closed 1 month ago

fadeev commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

This update introduces significant enhancements to the project's structure and functionality, including a refined workflow for NPM publishing, improved linting configurations, and the introduction of comprehensive TypeScript interfaces for smart contract interactions. The changes promote better organization, clarity, and adherence to best practices, ensuring a more robust development experience.

Changes

Files Change Summary
.github/workflows/... Updated NPM publishing workflow, including clearer input descriptions, simplified commands, and new steps for Foundry installation and file generation.
v2/eslint.config.js Introduced ESLint configuration to enforce coding standards and ignore specific directories during linting.
v2/package.json Changed package name to @zetachain/protocol-contracts, updated versioning, restructured file management with a focus on TypeScript support and enhanced developer tooling.
v2/types/... Introduced various TypeScript files defining interfaces and contracts for smart contract functionalities (e.g., AccessControl, ERC20, ERC1967Proxy, etc.), enhancing type safety and clarity across the codebase.
v2/scripts/generate_go.sh Modified artifact directory from ./out to ./abi, aligning with new project structure.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Actions
    participant Foundry
    participant NPM

    User->>GitHub Actions: Trigger Publish
    GitHub Actions->>Foundry: Install Toolchain
    GitHub Actions->>NPM: Publish Package
    NPM-->>User: Confirmation

🐰 "In the meadow where code does bloom,
With each update, joy will loom!
Workflows dance and linting sings,
New interfaces bring bright new things.
Hooray for changes, let’s hop and cheer,
For a rabbit’s world is now more clear!" 🐇✨

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
fadeev commented 1 month ago 
0s
Run VERSION_TAG="v[1](https://github.com/zeta-chain/protocol-contracts/actions/runs/10295529597/job/28495341535#step:5:1)0.0.0-rc1"
  VERSION_TAG="v10.0.0-rc1"
  if [[ $VERSION_TAG == *"-"* ]]; then
    echo "NPM_TAG=${VERSION_TAG#*-}" >> $GITHUB_ENV
  else
    echo "NPM_TAG=latest" >> $GITHUB_ENV
  shell: /usr/bin/bash -e {0}
  env:
    NPM_CONFIG_USERCONFIG: /home/runner/work/_temp/.npmrc
    NODE_AUTH_TOKEN: XXXXX-XXXXX-XXXXX-XXXXX
/home/runner/work/_temp/[2](https://github.com/zeta-chain/protocol-contracts/actions/runs/10295529597/job/28495341535#step:5:2)908da14-c826-437d-b7b7-7c05a4fbeebc.sh: line 6: syntax error: unexpected end of file
Error: Process completed with exit code 2.
codecov-commenter commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 68.97%. Comparing base (1b8e3c7) to head (72e8b3a). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #297 +/- ## ======================================= Coverage 68.97% 68.97% ======================================= Files 7 7 Lines 245 245 Branches 61 61 ======================================= Hits 169 169 Misses 76 76 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

fadeev commented 1 month ago

I renamed out to abi and typechain-types to types to make it easier to export and import files in these dirs. From what I can tell you can't map existing directories to different names in package.json.