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

build: don't reinstall golangci-lint if already installed #21662

Merged
merged 1 commit into from
Sep 12, 2024

Conversation

alessio
Copy link
Contributor

@alessio alessio commented Sep 11, 2024

Description

The Makefile's lint-install target should be no-op if the desired version
of golangci-lint is already installed in order to preserve user's
environment and not overwrite user's tools and config.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features
    • Enhanced linting script to check and ensure the correct version of golangci-lint is installed, preventing unnecessary installations and version conflicts.

@alessio alessio requested a review from a team as a code owner September 11, 2024 18:34
Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Walkthrough

Walkthrough

The changes introduce a new variable, golangci_installed_version, which captures the currently installed version of golangci-lint. The lint-install target is updated to compare this installed version with a specified version. If there is a mismatch, the script will install the correct version of golangci-lint, enhancing the script's capability to manage installations effectively.

Changes

Files Change Summary
scripts/build/linting.mk Added variable golangci_installed_version to capture the installed version of golangci-lint and modified lint-install target for version comparison.

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4e9a4e08f096ad23e05f2bd901f1fbd079e0ca9f and 991abcb.

Files selected for processing (1)
  • scripts/build/linting.mk (2 hunks)
Files skipped from review due to trivial changes (1)
  • scripts/build/linting.mk

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

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.

@alessio alessio changed the title chores: don't reinstall golangci-lint if already installed tools: don't reinstall golangci-lint if already installed Sep 11, 2024
@julienrbrt julienrbrt changed the title tools: don't reinstall golangci-lint if already installed build: don't reinstall golangci-lint if already installed Sep 11, 2024
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 11, 2024
lint-install should be no-op if the same version is already
installed in order to preserve user's environment and not
overwrite user's tools and config.
auto-merge was automatically disabled September 11, 2024 20:22

Head branch was pushed to by a user without write access

@tac0turtle tac0turtle added this pull request to the merge queue Sep 12, 2024
Merged via the queue into cosmos:main with commit 979f885 Sep 12, 2024
69 checks passed
mergify bot pushed a commit that referenced this pull request Sep 12, 2024
@alessio alessio deleted the dont-reinstall-golangci-lint branch September 12, 2024 06:56
alessio added a commit to alessio/cosmos-sdk that referenced this pull request Sep 12, 2024
alpe added a commit that referenced this pull request Sep 12, 2024
* main:
  docs(client/debug): correct `debug raw-bytes` command example (#21671)
  build: don't reinstall golangci-lint if already installed (#21662)
  refactor(server/v2): kill viper from server components (#21663)
  chore: sync changelog with latest releases (#21658)
  refactor: remove viper as a direct dependency (#21635)
  ci: centralized job for rocksdb libaries cache (#21657)
  fix: remove stray fmt.Println (#21661)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants