search

celestiaorg / nmt

Namespaced Merkle Tree
Apache License 2.0
117 stars 43 forks source link

ci: fix lint, markdown links, and build #282

Closed rootulp closed 1 week ago

rootulp commented 1 week ago

Closes https://github.com/celestiaorg/nmt/issues/269, https://github.com/celestiaorg/nmt/issues/275, https://github.com/celestiaorg/nmt/issues/279, https://github.com/celestiaorg/nmt/issues/222 (b/c no longer relevant)

Note: this PR removes code coverage. If we want it back, IMO it should be a separate workflow.

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 week ago

Walkthrough

The pull request introduces various changes to the workflow configurations and documentation for the Go project. The .github/workflows/go.yml file has been streamlined by reorganizing steps and removing unnecessary ones, particularly focusing on testing. The linting workflow in .github/workflows/lint.yml specifies a fixed version for the linter action. The .golangci.yml file modifies the enabled linters, while the Makefile adds new targets for linting and link checking. Documentation updates are made in several README files, and the Go version is upgraded in go.mod.

Changes

File Change Summary
.github/workflows/go.yml Reorganized steps; removed "Format" and "Test and Coverage"; updated Go setup to use go-version-file.
.github/workflows/lint.yml Updated golangci-lint-action version to v1.61.0.
.golangci.yml Removed exportloopref linter; added copyloopvar.
Makefile Added lint and markdown-link-check targets for running linters and checking Markdown links.
README.md Removed Go version and codecov badges; core content unchanged.
go.mod Updated Go version from 1.21 to 1.23.
nmt_quint_model/README.md Updated Quint specification documentation for clarity and accuracy.
subrootpaths_test.go Modified TestPathGeneration to ensure correct variable capture in test cases.

Assessment against linked issues

Objective Addressed Explanation
Fix dead links to informal quint (269) ✅

Possibly related issues

🐇 In the garden, I hop and play,
With changes made to brighten the day.
Linting and testing, all in a row,
A cleaner path for our code to grow!
🌱✨

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://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 1 week ago

Codecov Report

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

Project coverage is 69.54%. Comparing base (62ec215) to head (8d72690).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #282 +/- ## ========================================== + Coverage 68.01% 69.54% +1.52% ========================================== Files 6 6 Lines 1138 1484 +346 ========================================== + Hits 774 1032 +258 - Misses 337 425 +88 Partials 27 27 ```

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