chore(deps): update dependency yard to "~> 0.9", ">= 0.9.20" [security] #91
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.
This PR contains the following updates:
"~> 0.8"
->"~> 0.9", ">= 0.9.20"
GitHub Vulnerability Alerts
CVE-2017-17042
lib/yard/core_ext/file.rb
in the server in YARD before 0.9.11 does not block relative paths with an initial../
sequence, which allows attackers to conduct directory traversal attacks and read arbitrary files.CVE-2019-1020001
Possible arbitrary path traversal and file access via
yard server
Impact
A path traversal vulnerability was discovered in YARD <= 0.9.19 when using
yard server
to serve documentation. This bug would allow unsanitized HTTP requests to access arbitrary files on the machine of a yard server host under certain conditions.Thanks to CuongMX from Viettel Cyber Security for discovering this vulnerability.
Patches
Please upgrade to YARD v0.9.20 immediately if you are relying on yard server to host documentation in any untrusted environments.
Workarounds
For users who cannot upgrade, it is possible to perform path sanitization of HTTP requests at your webserver level. WEBrick, for example, can perform such sanitization by default (which you can use via
yard server -s webrick
), as can certain rules in your webserver configuration.Release Notes
lsegal/yard (yard)
v0.9.20
Compare Source
yard server
. This bug would allowunsanitized HTTP requests to access arbitrary files on the machine of a
yard server
host under certain conditions. Thanks to CuongMX fromViettel Cyber Security for discovering this vulnerability.
v0.9.19
Compare Source
Module#namespace_name
function (#1229)README.md over README.x.md or README-x.md (and the like). READMEs will now
also be ordered by filename; the first README is still chosen unless
--readme
is provided.v0.9.18
Compare Source
v0.9.17
Compare Source
v0.9.16
Compare Source
v0.9.15
Compare Source
execution. Credit to Nelson Elhage [email protected] for discovering this
issue.
v0.9.14
Compare Source
v0.9.13
Compare Source
@!group
directive (#1056).v0.9.12
Compare Source
specified by
yard doc
command.v0.9.11
Compare Source
--readme
that allowed for arbitrary file reads ondisk. Credit to ztz [email protected] for discovering this issue.
v0.9.10
Compare Source
--fail-on-warning
option foryard doc
which exits with a non-zerocode if there are any warnings (#1093).
Struct.new
blocks (#1099).@see (obj)
reference tags would fail (#1111)yard stats
(#1123).v0.9.9
Compare Source
gem uninstall
hooks to remove YARD documentation files. (#1083)the anchor section. (#1082)
v0.9.8
Compare Source
yard server
and by plugins.%w(...)
array syntax.v0.9.7
Compare Source
v0.9.6
Compare Source
in these versions, but support is not guaranteed. Simple bug fixes may still
be considered via pull request only. Issues without code will be automatically
closed.
of the type specification of a given tag. Also adds {YARD::Tags::TypesExplainer}
as an implementation class for the method.
Ruby syntax highlighted source code in generated HTML. Also adds the
{YARD::Parser::Ruby::TokenResolver} implementation class to iterate over
tokenized code with extra resolved object information.
A::B::C = true
).LibraryVersion#yardoc_file_for_SOURCE
callback method for sources witha pre-determined yardoc file location. Implement this method instead of
manually setting
library.yardoc_file = ...
in your load method (you canstill assign the attribute manually).
v0.9.5
Compare Source
yard doc
will now generate.yardoc/processing
and.yardoc/complete
filesto allow other tools to properly detect when YARD is in the middle of parsing
source files, and when it has completed writing the database.
:disk
source type. LibraryVersion objects pointing to a .yardoc databasedirectory will now auto-generate if there is a
source_path
attached.v0.9.4
Compare Source
v0.9.3
Compare Source
yard server --fork
v0.9.2
Compare Source
v0.9.1
Compare Source
Module#namespace_name
function (#1229)README.md over README.x.md or README-x.md (and the like). READMEs will now
also be ordered by filename; the first README is still chosen unless
--readme
is provided.v0.9.0
Compare Source
Special thanks to Alex Dowad, MSP-Greg, and Alex McLain for their extended
contributions to this version.
This change may affect backward compatibility if custom templates made modifications
to
default/fulldoc/html
, specifically the index or navigation lists.supports:
private def foo(x, y) end
in HTML comment blocks (
<!--\n @​metadata here... \n-->
). Ensure that the openingcomment tag is alone on the first line of the file to use this functionality.
yard server
.v0.8.7.6
Compare Source
@option
tag on keyword arg splat parameter. (#729).stats_options
forYardocTask
. (#800, #801)v0.8.7.5
Compare Source
are preceded by code. (#798)
@overload
tags. (#794)yard stats
for objects with no file property. (#792)Markdown standard.
private_class_method
support. (#760, #767)v0.8.7.4
Compare Source
private_class_method
(#747)v0.8.7.3
Compare Source
v0.8.7.2
Compare Source
v0.8.7.1
Compare Source
v0.8.7
Compare Source
@option
tag on keyword arg splat parameter. (#729).stats_options
forYardocTask
. (#800, #801)v0.8.6.2
Compare Source
yard graph
was not displaying methodsv0.8.6.1
Compare Source
yard display
to wrap output in layout template.v0.8.6
Compare Source
yard graph
was not displaying methodsv0.8.5.2
Compare Source
v0.8.5.1
Compare Source
yard diff
of gem files with RubyGems 2.xv0.8.5
Compare Source
v0.8.4.1
Compare Source
v0.8.4
Compare Source
v0.8.3
Compare Source
--non-transitive-tag
to disable tag transitivity (#571){include:Object#method}
syntax (#569)--api
and--no-api
support (#559)v0.8.2.1
Compare Source
v0.8.2
Compare Source
v0.8.1
Compare Source
--[no-]api
switch to generate docs for API sets (see {file:docs/WhatsNew.md} for details) (#532)yard list
command now uses cache by default (#533)yardoc
generating incorrectly named method list file (#528)Configuration
📅 Schedule: Branch creation - "" (UTC), Automerge - "before 4am on Monday" (UTC).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.