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

Alphabetize EnvConfig::ENVS #17074

Merged
merged 2 commits into from
Apr 11, 2024
Merged

Alphabetize EnvConfig::ENVS #17074

merged 2 commits into from
Apr 11, 2024

Conversation

issyl0
Copy link
Member

@issyl0 issyl0 commented Apr 11, 2024

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

  • Spoiler: they aren't.
  • Fixes Add a RuboCop rule for sorting EnvConfig keys #17027.
  • As part of Volunteer Month at work I introduced @hharen to contributing to Homebrew, cd $(brew --repo), brew tests, brew style, etc.
  • We also started to write a RuboCop for this. But my current thinking is that this test might be sufficient since it might be easier to notice "oops, a test is failing and I've added a new envvar" and re-alphabetize it than to write a RuboCop linter for it to do the one-time autofix. Considering how little this gets changed?

issyl0 and others added 2 commits April 11, 2024 17:58
- Spoiler: they aren't.
- As part of Volunteer Month at work I introduced `hharen` to contributing to
  Homebrew, `cd $(brew --repo)`, `brew tests`, `brew style`, etc.
- We started to write a RuboCop for this. But my current thinking is that this
  test might be sufficient since it might be easier to notice "oop, a test is
  failing and I've added a new envvar" and re-alphabetize it than to write a
  RuboCop linter for it to do the one-time autofix. Considering how little this
  gets changed?

Co-authored-by: Hana <[email protected]>
@issyl0 issyl0 changed the title Envconfig alphabetize Alphabetize EnvConfig::ENVS Apr 11, 2024
Copy link
Member

@ZhongRuoyu ZhongRuoyu left a comment

Choose a reason for hiding this comment

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

Thanks!

@issyl0 issyl0 merged commit 4f85192 into master Apr 11, 2024
26 checks passed
@issyl0 issyl0 deleted the envconfig-alphabetize branch April 11, 2024 19:33
@MikeMcQuaid
Copy link
Member

  • We also started to write a RuboCop for this. But my current thinking is that this test might be sufficient since it might be easier to notice "oops, a test is failing and I've added a new envvar" and re-alphabetize it than to write a RuboCop linter for it to do the one-time autofix. Considering how little this gets changed?

Yup, I agree, great work here @issyl0 and @hharen (and nice to "see" you again @hharen)!

@hharen
Copy link
Contributor

hharen commented Apr 12, 2024

Indeed, I totally didn't know that homebrew is written in Ruby! ❤️❤️❤️

@github-actions github-actions bot added the outdated PR was locked due to age label May 13, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a RuboCop rule for sorting EnvConfig keys
5 participants