[DOC] Add security documentation #3928
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
st0012
added
documentation
vinistock
reviewed
Jan 27, 2026
|
|
||
| - Execute any code in your Gemfile (Gemfiles are Ruby code) | ||
| - Install gems specified in the Gemfile, which may include native extensions that execute during installation | ||
| - Run any post-install hooks defined by gems |
Member
There was a problem hiding this comment.
Does RubyGems allow for post-install hooks? I thought you could only show messages.
Member
Author
There was a problem hiding this comment.
It's not a direct post-install hook. But you can use spec.rdoc_options to specify what RDoc should run to generate your gem's documentation for ri (which will be invoked by rubygems), including running your rdoc options etc.
st0012
force-pushed
the
add-security-doc
branch
from
0c4d52d to
c310ff3
Compare
st0012
force-pushed
the
add-security-doc
branch
from
c310ff3 to
1603db0
Compare
vinistock
approved these changes
Jan 28, 2026
|
|
||
| - Execute any code in your Gemfile (Gemfiles are Ruby code) | ||
| - Install gems specified in the Gemfile, which may include native extensions that execute during installation | ||
| - Run any post-install hooks defined by gems |
rafaelfranca
approved these changes
Jan 28, 2026
Co-authored-by: Vinicius Stock <vinistock@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Ruby LSP, by design, can execute code (e.g. run
bundle install) when the user simply opening the project in VS Code under trusted mode. This is necessary for usability and it's a common practice among language servers and their extensions. But the risk should be clearly communicated with users.Implementation
Add a page to document known (but not exhaustive) code executions that could be performed by Ruby LSP so users can be aware of the potential risks.
Automated Tests
Manual Tests