ci: support releasing proto definitions to BSR

rach-id commented 1 month ago

Adds support for pushing the proto definitions to BSR

Summary by CodeRabbit

New Features
- Introduced a continuous integration (CI) workflow for automated checks on Protocol Buffers.
- Added a new module configuration for managing protocol buffers.
Documentation
- New workflow file created to outline CI processes.
- Configuration file established for module versioning and structure.

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@rach-id has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 55 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](https://coderabbit.ai/docs/faq) for further information.

Commits
Files that changed from the base of the PR and between 0813aca06be8c52dde516cdfda5e1945caa6e054 and 2ef7a65a7fbc6ffc122ed7cabf92f65efaa2e55c.

Walkthrough

The changes introduce a new GitHub Actions workflow file, buf-ci.yaml, to automate continuous integration processes for a project utilizing Buf for managing Protocol Buffers. Additionally, a new configuration file, buf.yaml, is added, specifying the module's structure and versioning, along with linting rules. These updates collectively enhance the project's CI capabilities and define the module's configuration while addressing potential breaking changes.

Changes

Files	Change Summary
.github/workflows/buf-ci.yaml	New workflow added for continuous integration using Buf, triggered by specific events.
buf.yaml	New configuration file created, defining a module with path `pb` and name `buf.build/celestia/nmt`, version `v2`. Linting rules added to ignore specific issues for `pb/proof.proto`.

Poem

In the meadow where code does play,
A new workflow hops in, hip-hip-hooray!
With Buf by our side, we’ll check and refine,
Protocols dancing, all in a line.
So let’s celebrate with a joyful cheer,
For CI is here, bringing us near! 🐇✨

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 , 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](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.

github-actions[bot] commented 1 month ago

The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).

Build	Format	Lint	Breaking	Updated (UTC)
`✅ passed`	`✅ passed`	`✅ passed`	`✅ passed`	Sep 24, 2024, 7:10 PM

codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 68.01%. Comparing base (29e9433) to head (2ef7a65). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #274 +/- ## ======================================= Coverage 68.01% 68.01% ======================================= Files 6 6 Lines 1138 1138 ======================================= Hits 774 774 Misses 337 337 Partials 27 27 ```

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

rach-id commented 1 month ago

CI will be fixed by: https://github.com/celestiaorg/nmt/pull/276 and https://github.com/celestiaorg/nmt/issues/275

rach-id commented 1 month ago

How was this PR tested? Did your fork push proto definitions to Buf Schema Registry successfully? Or will it be tested after this PR merges?

it should be tested after the PR is merged

github-actions[bot] commented 1 month ago

The latest Buf updates on your PR. Results from workflow buf-ci / buf (pull_request).

Build	Format	Lint	Breaking	Updated (UTC)
`✅ passed`	`✅ passed`	`✅ passed`	`✅ passed`	Sep 24, 2024, 7:12 PM

MSevey commented 1 month ago

How was this PR tested? Did your fork push proto definitions to Buf Schema Registry successfully? Or will it be tested after this PR merges?

it should be tested after the PR is merged

For GH actions that can't be tested on the PR, because they require being on main to be tested, I recommend either using a fork or having a personal repo like workflows where you can do all testing on the action to make sure it works.

I have a MSevey/workflows repo or example that I do a lot of testing on for new actions to better understand them prior to merging into a project.

rach-id commented 1 month ago

I tried running this in a personal repo but I keep hitting certain upload permission errors. I will merge this one, test it. if it works, there is no need to waste more time on it. If not, I will fix in a follow up PR

celestiaorg / nmt