Support Ruby 3 #949
Support Ruby 3 #949
Conversation
fc71a46 to
3aba47a
Compare
Bump CircleCI ruby orb to `circleci/ruby@1.1.2` Combine `lint` and `test` / `test_jruby` jobs. JRuby job now installs "java" gems correctly. Heavily inspired by `rubocop-rails` config. See: https://github.com/rubocop/rubocop-rails/blob/f3a00977d8621a2af037cc8625cd2734e2c11a56/.circleci/config.yml
|
Ruby 3 contains a number of changes: However, the only relevant change appears to be: This PR changes the CircleCI config to support Ruby 3, but also refactors the config. |
| @@ -156,7 +156,7 @@ def include_issues_by_labels(issues) | |||
| filter_wo_labels(filtered_issues) | |||
| end | |||
|
|
|||
| # @param [Array] issues Issues & PRs to filter when without labels | |||
| # @param [Array] items Issues & PRs to filter when without labels | |||
There was a problem hiding this comment.
It's debatable whether this commit belongs in this PR.
I would probably prefer a Rubocop cop or something that auto-corrects this.
There was a problem hiding this comment.
Yard-junk is a tool for this. Finding errors and presenting them in a small report.
| @@ -382,6 +388,7 @@ def commits_in_tag(sha, shas = Set.new) | |||
| shas | |||
| end | |||
|
|
|||
| # @param [Object] indata | |||
There was a problem hiding this comment.
These are super cool additions, and type descriptions in Yard can use a comma to separate each matching type like [Array, Hash] etc.
| @@ -442,6 +452,7 @@ def iterate_pages(client, method, *arguments, parent: nil, **options) | |||
| # This is wrapper with rescue block | |||
| # | |||
| # @return [Object] returns exactly the same, what you put in the block, but wrap it with begin-rescue block | |||
| # @param [Proc] block | |||
There was a problem hiding this comment.
Yard probably has some notation for you here, specific to blocks. We don't want the docs to show that this method takes a positional argument. Does the rendered Yard docs HTML show that?
| @@ -483,6 +496,7 @@ def retry_callback | |||
| end | |||
| end | |||
|
|
|||
| # @param [Object] msg | |||
There was a problem hiding this comment.
This type is String.
| @@ -453,6 +464,8 @@ def check_github_response(&block) | |||
| end | |||
|
|
|||
| # Presents the exception, and the aborts with the message. | |||
| # @param [Object] message | |||
| # @param [Object] error | |||
There was a problem hiding this comment.
Error is Exception I guess.
| @@ -453,6 +464,8 @@ def check_github_response(&block) | |||
| end | |||
|
|
|||
| # Presents the exception, and the aborts with the message. | |||
| # @param [Object] message | |||
There was a problem hiding this comment.
Message is a String.
| # | ||
| # @yield [Sawyer::Resource] An OctoKit-provided response (which can be empty) | ||
| # | ||
| # @return [void] | ||
| # @param [Hash] options |
There was a problem hiding this comment.
Minor: this param should be placed before th return Yard directive.
| @@ -357,6 +361,8 @@ def fetch_tag_shas(tags) | |||
|
|
|||
| private | |||
|
|
|||
| # @param [Set] shas | |||
| # @param [Object] sha | |||
There was a problem hiding this comment.
The sha is String, I think.
| @@ -335,6 +338,7 @@ def default_branch | |||
| @default_branch ||= client.repository(user_project)[:default_branch] | |||
| end | |||
|
|
|||
| # @param [Object] name | |||
| @@ -170,6 +170,7 @@ def filter_wo_labels(items) | |||
| end | |||
|
|
|||
| # @todo Document this | |||
| # @param [Object] issues | |||
There was a problem hiding this comment.
This enumerable is probably an Array
|
Hi, I made copious inline comments. Also: yay! A great move to begin using the Ruby Orb better. |
|
In order to use this, I will move forward without fixing the pointed-out YARD annotations. |
Cool thanks, makes sense. I saw your comments about YARD but did not have time to go through them all. |
No description provided.