Update Ruby to 3.3.7 and improve Docker setup: - Update Gemfile with … #1192
Conversation
…compatible gem versions - Enhance Docker instructions in contributing.md - Add troubleshooting steps
WalkthroughVersion constraints were added to the Gemfile for the 'builder', 'nokogiri', and 'feedbag' gems. The contributing guidelines were updated to clarify Docker-based setup, upgrade the Ruby version to 3.3.7, provide detailed OPML generation steps, and add troubleshooting notes for dependency and Docker management. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (8)
Gemfile (1)
3-5: Sort gems alphabetically.To comply with Bundler/OrderedGems, list
feedbagbeforenokogiri:-gem 'builder', '~> 3.2' -gem 'nokogiri', '~> 1.15.0' -gem 'feedbag', '~> 0.9.13' +gem 'builder', '~> 3.2' +gem 'feedbag', '~> 0.9.13' +gem 'nokogiri', '~> 1.15.0'contributing.md (7)
15-15: Clarify Docker prerequisites.Mention that Docker must be installed and running on the host before proceeding.
18-20: Enhance the Docker run step.Mount the project directory to avoid in-container cloning:
docker run -it \ -v $(pwd):/engineering-blogs \ -e LANG=C.UTF-8 \ --name blogs \ ruby:3.3.7 /bin/bash
26-28: Offer SSH clone alternative.For users with SSH access, propose:
git clone [email protected]:<username>/engineering-blogs.git
29-31: Caution: removing Gemfile.lock.Dropping
Gemfile.lockunconditionally may bump dependencies unexpectedly. Note this is only needed when switching Ruby majors.
42-44: Suggest leveraging volume mount.If you use the volume suggestion above, you can skip
docker cpand read the file directly on the host.
49-49: Remove trailing punctuation in heading.Drop the colon to satisfy markdownlint’s no-trailing-punctuation rule:
-### Important Notes: +### Important Notes
55-55: Add comma for readability.Insert a comma after “important”:
- The dot (.) at the end of the command is important as it specifies the current directory as the destination. + The dot (.) at the end of the command is important, as it specifies the current directory as the destination.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
Gemfile(1 hunks)contributing.md(1 hunks)
🧰 Additional context used
🪛 RuboCop (1.75.5)
Gemfile
[convention] 5-5: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem feedbag should appear before nokogiri.
(Bundler/OrderedGems)
🪛 LanguageTool
contributing.md
[uncategorized] ~55-~55: Possible missing comma found.
Context: ...he dot (.) at the end of the command is important as it specifies the current directory a...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
contributing.md
49-49: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (5)
contributing.md (5)
22-24: Approve RubyGems & Bundler update.Updating RubyGems and installing Bundler inside the container is best practice for compatibility.
32-34: Approve dependency installation.Fresh
bundle installaligns with updated Gemfile and Ruby version.
35-37: Approve OPML generation.
ruby generate_opml.rbis clear and matches script naming.
38-40: Approve exit instruction.Highlighting container exit before file copy is essential.
45-47: Approve container cleanup.Removing the
blogscontainer prevents leftovers.
1 participant
…compatible gem versions - Enhance Docker instructions in contributing.md - Add troubleshooting steps
Summary by CodeRabbit