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

imp(ci): Add CI workflows, configurations, Makefile, License, etc. #12

Merged
merged 5 commits into from
Jul 31, 2024

Conversation

MalteHerrmann
Copy link
Collaborator

@MalteHerrmann MalteHerrmann commented Jul 31, 2024

This PR adds the boilerplate code like CI setup, license information, configuration files, etc. to the repo.
I cleaned up the things we have on Evmos to fit the current state of the OS repo - i.e. as a first step it's not planned that this repository contains an actual running chain implementation, which I maybe want to add in a follow up PR (think like mini but with the EVM).

Hence, I removed all of the build related stuff and Docker and Nix tests etc. - those will be added later if required

Summary by CodeRabbit

  • New Features

    • Introduced structured configurations for issue templates, code ownership, and changelog management to enhance project organization.
    • Added automated workflows for dependency management, security analysis, linting, and testing across various programming languages and file types.
    • Established a comprehensive build system through a new Makefile to streamline development tasks.
  • Documentation

    • Created a CHANGELOG.md to systematically document changes and updates.
    • Established new licensing documentation (LICENSE and LICENSE_FAQ.md) clarifying usage rights and limitations.
  • Chores

    • Enhanced the .gitignore file for better management of ignored files and directories across development environments.

Copy link

coderabbitai bot commented Jul 31, 2024

Warning

Rate limit exceeded

@MalteHerrmann has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 47 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between bc3b991 and 2a7faea.

Walkthrough

This commit introduces a comprehensive set of configurations and workflows aimed at enhancing project management, code quality, and security in the Evmos repository. Key updates include structured templates for issue and pull request management, automated workflows for linting, testing, and dependency checks, as well as configuration files for various tools. These changes improve collaboration, streamline processes, and reinforce best practices across the development lifecycle.

Changes

Files/Paths Change Summary
.clconfig.json Added a configuration file for organizing change types and categories, enhancing clarity and consistency in change management.
.github/CODEOWNERS Introduced a new CODEOWNERS file to specify repository maintainers, improving code contribution oversight.
.github/ISSUE_TEMPLATE/*.yml Added structured templates for bug reports and feature requests to streamline the issue reporting process.
.github/PULL_REQUEST_TEMPLATE.md Introduced a pull request template to standardize submissions, including checklists for authors and reviewers.
.github/workflows/*.yml Added multiple CI/CD workflows for tasks like linting, testing, dependency management, and security checks to automate processes and improve code quality.
.gitignore Updated to include patterns for ignoring unnecessary files generated by various systems, improving repository cleanliness.
LICENSE, LICENSE_FAQ.md Introduced licensing files outlining the terms for the Evmos Non-Commercial License, ensuring clarity on usage rights and obligations.
.gitleaks.toml, .golangci.yml, .markdownlint.yml New config files for Gitleaks and linting tools to enhance security and code quality checks.
Makefile Introduced a build system for managing development tasks across Go modules and Solidity contracts.
SAFU.md, SECURITY.md New documents outlining policies for managing funds after exploits and guidelines for reporting vulnerabilities, promoting security awareness.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant CI/CD Pipeline
    participant Tools

    User->>GitHub: Creates Issue/Pull Request
    GitHub->>User: Displays Templates
    User->>GitHub: Fills in Template
    GitHub->>CI/CD Pipeline: Triggers Workflows
    CI/CD Pipeline->>Tools: Runs Linting, Testing, etc.
    Tools-->>CI/CD Pipeline: Returns Results
    CI/CD Pipeline->>GitHub: Updates Issue/Pull Request Status
Loading

🐰 Hop along, we’ve made a change,
New workflows to help us rearrange!
Bugs and features now reported with flair,
Our code shines bright, with nary a care!
In this garden of code, let’s grow and play,
With templates and checks, we’ll hop on our way! 🌱✨


Note

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://app.coderabbit.ai/login.

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

@MalteHerrmann MalteHerrmann merged commit cfa87f2 into main Jul 31, 2024
12 of 23 checks passed
@MalteHerrmann MalteHerrmann deleted the malte/setup-ci branch July 31, 2024 13:33
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