Fix docs generation locally on Windows. #34629
Conversation
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
home-assistant
bot
added
current
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces updates to the Changes
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| @@ -8,8 +8,7 @@ group :development do | |||
| gem 'compass', '1.0.3' | |||
| gem 'sass-globbing', '1.1.5' | |||
| gem 'stringex', '2.8.6' | |||
| # > 2.1.0 causes slowdowns https://github.com/sass/sassc-ruby/issues/189 | |||
| gem 'sassc', '2.1.0' | |||
| gem 'sassc', '2.4.0' | |||
There was a problem hiding this comment.
Approve version update but recommend sorting gems alphabetically.
The update of sassc from 2.1.0 to 2.4.0 is crucial for resolving compatibility issues and should be approved. However, to adhere to best practices and maintain consistency within the Gemfile, it's recommended to sort the gems alphabetically within their section as suggested by rubocop.
Consider rearranging the gems to maintain alphabetical order:
gem 'rubocop', '1.66.1'
gem 'ruby-lsp', '0.17.17'
gem 'rackup', '2.1.0'
+ gem 'sassc', '2.4.0'
gem 'sass-globbing', '1.1.5'
- gem 'sassc', '2.4.0'
gem 'stringex', '2.8.6'Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| gem 'sassc', '2.4.0' | |
| gem 'rubocop', '1.66.1' | |
| gem 'ruby-lsp', '0.17.17' | |
| gem 'rackup', '2.1.0' | |
| gem 'sassc', '2.4.0' | |
| gem 'sass-globbing', '1.1.5' | |
| gem 'stringex', '2.8.6' |
Tools
rubocop
[convention] 11-11: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem
sasscshould appear beforestringex.(Bundler/OrderedGems)
|
I'm a bit confused by the bot action, I don't think this should be targeting the |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
Gemfile (1)
Line range hint
1-35: Consider cross-platform compatibility and clarify branching strategy.While these changes address issues specific to Windows environments, it's important to ensure they don't negatively impact other platforms. Consider adding comments in the Gemfile to explain the Windows-specific changes and their purpose.
Regarding the confusion about the target branch:
- Verify that these changes are intended for the
currentbranch, as mentioned in your comment.- If confirmed, update the PR to target the correct branch.
- Consider documenting the branching strategy in the project's contributing guidelines to avoid future confusion.
🧰 Tools
🪛 rubocop
[convention] 8-8: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem
compassshould appear beforejekyll.(Bundler/OrderedGems)
[convention] 11-11: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem
sasscshould appear beforestringex.(Bundler/OrderedGems)
[convention] 12-12: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem
rubocopshould appear beforesassc.(Bundler/OrderedGems)
[convention] 14-14: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem
rackupshould appear beforeruby-lsp.(Bundler/OrderedGems)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (1)
Gemfile.lockis excluded by!**/*.lock
📒 Files selected for processing (1)
- Gemfile (2 hunks)
🧰 Additional context used
🪛 rubocop
Gemfile
[convention] 11-11: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem
sasscshould appear beforestringex.(Bundler/OrderedGems)
🔇 Additional comments (1)
Gemfile (1)
11-11: Approvesasscversion update.The update of
sasscfrom 2.1.0 to 2.4.0 aligns with the PR objectives and should resolve the reported C++ compiler error. This change is crucial for fixing the documentation generation issues on Windows.Note: While the gems are not sorted alphabetically (as noted in a previous review), this is a minor style issue that doesn't affect functionality. It can be addressed in a separate PR if desired.
🧰 Tools
🪛 rubocop
[convention] 11-11: Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem
sasscshould appear beforestringex.(Bundler/OrderedGems)
| @@ -8,8 +8,7 @@ group :development do | |||
| gem 'compass', '1.0.3' | |||
| gem 'sass-globbing', '1.1.5' | |||
| gem 'stringex', '2.8.6' | |||
| # > 2.1.0 causes slowdowns https://github.com/sass/sassc-ruby/issues/189 | |||
| gem 'sassc', '2.1.0' | |||
| gem 'sassc', '2.4.0' | |||
There was a problem hiding this comment.
We cannot change this, as per the comment on the existing code.
See: sass/sassc-ruby#189
If this is problematic for Windows, I think it is better to start documenting you cannot use this on Windows.
../Frenck
There was a problem hiding this comment.
Oh, I completely misread the purpose of that comment! I'll try to sort this out with the older version - see if there's some other way to make that gem compatible to be installed at 2.1.0
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Proposed change
The "Manual Environment" described in the docs for setting up a local workflow for working on the HA docs fails on Windows (using mingw) at the moment.
These changes got it working for me, but I'm no Ruby expert, so feel free to tell me to go pound sand with this PR.
Two upgrades were required:
bundlein the installation instruction steps).bundle). Version 0.2.0 of wdm was published to address this issue and support newer Ruby versions last month. I dropped back to run with Ruby 3.1.6, after I found this PR that mentioned 3.2+ is not supported yet since the removal ofexists?breaks Compass. (Since wdm is Windows only, I suspect folks haven't been running locally on Windows with a manual environment since that upgrade.)Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
sasscgem to version2.4.0for improved performance and compatibility.wdmgem to version0.2.0to enhance functionality for Windows users.