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

Run golangci-lint as part of build workflow #37

Merged
merged 1 commit into from
Dec 13, 2024
Merged

Conversation

eest
Copy link
Member

@eest eest commented Dec 13, 2024

Given the additional .golangci.yml changes this should roughly represent the linting tools mentioned in the README not already called from the Makefile.

Summary by CodeRabbit

  • New Features
    • Integrated a new linting step for Go code in the build process.
    • Expanded linting capabilities by adding gofumpt and gosec for formatting and security checks.

Given the additional .golangci.yml changes this should roughly represent
the linting tools mentioned in the README not already called from the
Makefile.
@eest eest requested a review from a team as a code owner December 13, 2024 12:07
Copy link

coderabbitai bot commented Dec 13, 2024

Walkthrough

The pull request introduces updates to the workflow configuration in .github/workflows/build.yml by adding a new job step for linting Go code using golangci-lint. This step is positioned between the "Display Go version" and "Build" steps. Additionally, the .golangci.yml configuration file has been modified to include new linters, gofumpt and gosec, enhancing the project's linting capabilities.

Changes

File Change Summary
.github/workflows/build.yml Added a new step "golangci-lint" using golangci/golangci-lint-action@v6 for linting Go code.
.golangci.yml Added linters gofumpt and gosec to the enable section.

Possibly related PRs

  • Update deps and go #32: The changes in .github/workflows/build.yml in both the main PR and this retrieved PR involve modifications to the workflow configuration, specifically related to the Go version used in the build process.

🐇 In the meadow, a new tune,
Linting code, we'll hum it soon.
With gofumpt and gosec in play,
Our Go code shines, hip-hip-hooray!
Hopping high with every check,
Clean and safe, what the heck! 🌼


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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

Copy link

@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 (1)
.github/workflows/build.yml (1)

Line range hint 7-8: Fix incorrect Go version in matrix strategy.

The specified Go version 1.23.3 is invalid as it doesn't exist. The latest stable Go version is in the 1.21.x series.

Apply this diff to fix the version:

    strategy:
      matrix:
-       go-version: ['1.23.3']
+       go-version: ['1.21.5']
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 637dbad and a01f871.

📒 Files selected for processing (2)
  • .github/workflows/build.yml (1 hunks)
  • .golangci.yml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .golangci.yml
🔇 Additional comments (1)
.github/workflows/build.yml (1)

19-22: LGTM! Verify golangci-lint configuration.

The integration of golangci-lint into the workflow looks good. The placement between version display and build steps is appropriate.

Let's verify the golangci-lint configuration:

✅ Verification successful

golangci-lint configuration is properly set up and aligned with README

The verification confirms that:

  • .golangci.yml exists and enables the required linters (revive, gofumpt, gosec)
  • README correctly documents the use of golangci-lint with a reference to the official documentation
  • The workflow configuration matches the documented setup
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for .golangci.yml configuration and enabled linters
# Expected: Find .golangci.yml with gofumpt and gosec enabled

# Check if .golangci.yml exists and show its content
cat .golangci.yml

# Verify if README mentions the linting tools
rg -i "lint|golangci" README.md

Length of output: 209

@eest eest merged commit 853ee60 into main Dec 13, 2024
2 checks passed
@eest eest deleted the golangci-lint-action branch December 13, 2024 12:11
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.

1 participant