zverok / yard-junk

Get rid of the junk in your YARD docs
70 stars 3 forks source link

Issue for Rake task CI users: explicit version on did_you_mean dependency #21

Closed olleolleolle closed 7 years ago

olleolleolle commented 7 years ago

Situation: As a CI user of the Rake task, I can have gem activation issues due to explicit version demands. Example: https://github.com/cucumber/aruba/issues/492#issuecomment-327731194

Resolution for that project: stop using it in CI. https://github.com/cucumber/aruba/pull/493

(This is a vague description of the issue, but I wanted it saved, here, so that we can deal with it together.)

zverok commented 7 years ago

Oh damn. I've already had a fight with the bundled gem on CI, but probably solved the problem in a wrong way :( On it.

zverok commented 7 years ago

Seems that simplified version of setting up the dependency did the trick: https://travis-ci.org/zverok/yard-junk

Do we have any way of test it against aruba's Travis?..

BTW, I've also noticed aruba supports Rubies since 1.9.3. Till today, yard-junk supported only Ruby >= 2.3.0, but I added 2.1 and 2.2 in master.

Not sure about 2.0 and 1.9.3 -- it is possible to support them, probably... But I don't really want to :)

zverok commented 7 years ago

(Though, in fact, it doesn't look as a really important task to support all Ruby versions, as docs could be checked only on one of them.)

olleolleolle commented 7 years ago

docs could be checked only on one

This is a good point. This could be the way forward that we teach.

It could be worth exampling this with a Travis CI config snippet which uses a matrix line which uses rvm: 2.4.1 and does a script: bundle exec rake yard:junk

zverok commented 7 years ago

So, my CI is green now... Wanna me to release new gem version?

olleolleolle commented 7 years ago

@zverok Would be great!

zverok commented 7 years ago

Done!

olleolleolle commented 7 years ago

I will close this as fixed and open another issue if it appears.

zverok commented 7 years ago

Hey. Just notifying: I've did the SECOND fix of the problem, now hopefully the right way. Released with 0.0.5