Skip to content

Upgrade yard to 0.9.12, motivated by CVE. #1938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from

Conversation

xaviershay
Copy link
Member

No description provided.

@xaviershay
Copy link
Member Author

I don't know WTF is going on with the build but I don't think it's green on master.

@pirj
Copy link
Member

pirj commented Dec 8, 2019

Rebased on master and changed the version to the latest 0.9.12 -> 0.9.20.

@pirj
Copy link
Member

pirj commented Dec 8, 2019

Doc diff is 2k+ lines, needs to be closely looked at.

@JonRowe
Copy link
Member

JonRowe commented Dec 9, 2019

😬 Can you push the diff up to a branch on rspec/rspec.github.io ?

@pirj
Copy link
Member

pirj commented Dec 9, 2019

@JonRowe Pushed here.

@JonRowe
Copy link
Member

JonRowe commented Dec 9, 2019

@pirj there is a task in the rspec-dev repo for creating docs, if you use that the diff size will reduce as a lot of lines will be incorrectly linking to assets

We might need to work on that further to streamline the changes / cleanup the files I'm seeing random ws changes we probably don't need.

@pirj
Copy link
Member

pirj commented Dec 9, 2019

There might be some difference due to:

[error]: Error loading plugin 'yard-rspec-docs-template'

I'll get back to this a bit later.

@JonRowe
Copy link
Member

JonRowe commented Dec 9, 2019

Heh, that might not be relevant :)

@pirj
Copy link
Member

pirj commented Dec 9, 2019

@JonRowe Here it is.

Gemfile Outdated
@@ -7,7 +7,7 @@ gemspec
rspec_dependencies_gemfile = File.expand_path("../Gemfile-rspec-dependencies", __FILE__)
eval_gemfile rspec_dependencies_gemfile

gem 'yard', '~> 0.8.7', require: false
gem 'yard', '~> 0.9.20', :require => false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can now jump to 0.9.22 :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same problem as before though

@benoittgt
Copy link
Member

So the issue is that the diff is too big?

I ran the command bundle exec rake update_docs from rspec-dev but the diff is way too big. 🧐
https://github.com/rspec/rspec.github.io/compare/re-enable-yard-check?expand=1

I didn't specify release tag in rake command argument, but even without release tags I think I miss something.

Also I may have found a way to get rid of this error #1938 (comment) by installing the gem from rspec.github.io gem build then gem install. But I am not sure.

@JonRowe
Copy link
Member

JonRowe commented Jan 1, 2020

The diffs are large because they're html and the format will have changed, whats unfortunately needed is to check that our docs are still valid, its probably easier to compare the rendered result than the diff itself...

@benoittgt
Copy link
Member

I opened a draft PR with the changes. rspec/rspec.github.io#131

As I mentioned in the draft PR. I am wondering if this PR should go to maintenance branch instead of master if we regenerate the documentation.

@JonRowe
Copy link
Member

JonRowe commented Jan 2, 2020

For rspec-rails it will need to go to 3-9-maintenance for sure.

@benoittgt benoittgt changed the base branch from master to 3-9-maintenance January 2, 2020 14:44
@JonRowe JonRowe added this to the 4.0.0 milestone Jan 15, 2020
@JonRowe JonRowe added the v4.0 label Jan 15, 2020
@JonRowe JonRowe mentioned this pull request Jan 15, 2020
@benoittgt
Copy link
Member

Closed by #2285

@benoittgt benoittgt closed this Mar 10, 2020
@benoittgt benoittgt deleted the upgrade-yard branch March 10, 2020 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants