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

Centralize Ruby Version to .ruby-version #56

Merged
merged 1 commit into from May 1, 2024

Conversation

george-ma
Copy link
Contributor

@george-ma george-ma commented Mar 26, 2024

The .ruby-version file is the ecosystem standard for defining a Ruby version. This PR adds the .ruby-version file, ensures a required_ruby_version is set, and removes all other references to Ruby in this repository, aligning it with the standard.

Important

Please verify the following before merging:

Verify that the changes in the PR meets the following requirements or adjust manually to make it compliant:

  • .ruby-version file is present with the correct Ruby version defined
  • A required_ruby_version in your gemspec is set
  • There is no Ruby version present in the dev.yml Ruby task (before: - ruby: x.x.x, after: - ruby)
  • There is no Ruby version/requirement referenced in the Gemfile (no lines with ruby <some-version>)
  • A Gemfile.lock is built with the defined Ruby version
  • The version of Rubocop installed is 1.61.0 or greater
  • There is no TargetRubyVersion defined in rubocop.yml
  • There is no Ruby argument present in ruby/setup-ruby Github Actions that do not run on a Ruby matrix (no lines with ruby-version: “x.x”)

Please merge this PR if it looks good, this PR will be merged if there isn't any activity after 4 weeks.

The `.ruby-version` file is the ecosystem standard for defining a Ruby version.  This PR adds the `.ruby-version` file, ensures a `required_ruby_version` is set, and removes all other references to Ruby in this repository, aligning it with the standard.
> [!IMPORTANT]
> Please verify the following before merging:

Verify that the changes in the PR meets the following requirements or adjust manually to make it compliant:
  - [ ] `.ruby-version` file is present with the correct Ruby version defined
  - [ ] A `required_ruby_version` in your gemspec is set
  - [ ] There is no Ruby version present in the  `dev.yml` Ruby task (before: `- ruby: x.x.x`, after: `- ruby`)
  - [ ] There is no Ruby version/requirement referenced in the `Gemfile` (no lines with `ruby  <some-version>`)
  - [ ] A `Gemfile.lock` is built with the defined Ruby version
  - [ ] The version of Rubocop installed is 1.61.0 or greater
  - [ ] There is no `TargetRubyVersion` defined  in `rubocop.yml`
  - [ ] There is no Ruby argument  present in  `ruby/setup-ruby` Github Actions that do **not**  run on a Ruby matrix (no lines with `ruby-version: “x.x”`)

Please merge this PR if it looks good, this PR will be merged if there isn't any activity after 4 weeks.
@sbfaulkner
Copy link
Contributor

@george-ma how does .ruby-version interact with the CI matrix?

@george-ma
Copy link
Contributor Author

Hey @sbfaulkner! They're independent concepts, the version defined in .ruby-version is the intended version for local development but as this is a library it supports a minimum ruby version (3.0.0) and so we test all versions >= 3.0.0 in the CI matrix

@sbfaulkner sbfaulkner merged commit 898a35f into main May 1, 2024
7 checks passed
@sbfaulkner sbfaulkner deleted the centralize_ruby_version branch May 1, 2024 13:48
Copy link
Contributor

@sbfaulkner sbfaulkner left a comment

Choose a reason for hiding this comment

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

👍

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.

None yet

2 participants