search

vitalab / vitalab.github.io

Website of the Vitalab :
https://vitalab.github.io/
55 stars 14 forks source link

ENH/FIX: Freeze dependencies and add troubleshooting section in `how-to` #499

Closed AntoineTheb closed 4 years ago

AntoineTheb commented 4 years ago

MIGHT INDUCE BREAKING CHANGES

As title suggests, I had changed the jekyll requirements to be above a certain version. However that might create some problems in the future, so I have frozen it to a certain version again (which is higher than what it was before).

If your local instance of the repo doesn't run after the update, please follow the instructions at the end of how-to.md. Don't hesitate to ask for help.

lemairecarl commented 4 years ago

Seems reasonable.

I pulled the branch, and on that commit bundle exec jekyll serve still worked.

Then, I tried to update bundler using gem install bundler:2.1.4 and bundle install as instructed in the how-to. Everything still works. However, there was a change on my Gemfile.lock:

$ git diff
diff --git a/Gemfile.lock b/Gemfile.lock
index 6a78800a..22edad55 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -76,7 +76,7 @@ DEPENDENCIES
   tzinfo-data

 RUBY VERSION
-   ruby 2.6.2p47
+   ruby 2.4.0p0

 BUNDLED WITH
    2.1.4

I had an old version of ruby, so I did this:

rbenv install 2.6.2
rbenv global 2.6.2
gem install bundler:2.1.4  # need to install bundler after upgrading ruby
bundle install

Now everything seems to work, and I don't have changes on Gemfile.lock.

When I saw the change on Gemfile.lock, I knew that I should upgrade ruby using rbenv, and I should not commit Gemfile.lock. The solution is not evident. I guess we'll have to be on the lookout in future PR's, as there will probably be some Gemfile.lock changes sneaking in. Also, I'm going to add a sections in the troubleshooting section about this.

AntoineTheb commented 4 years ago

Seems like I didn't follow the instructions and installed a version different than what was specified in how-to-install-ruby.md, woops. I can change my version back to 2.4.0, and if everyone makes sure they're on this version also, we won't have troubles with Gemfile.lock.

nathanpainchaud commented 4 years ago

Seems like I didn't follow the instructions and installed a version different than what was specified in how-to-install-ruby.md, woops. I can change my version back to 2.4.0, and if everyone makes sure they're on this version also, we won't have troubles with Gemfile.lock.

I think it would be better to force people to update in this case, since support for Ruby 2.4 has ended in April.

lemairecarl commented 4 years ago

While we're at it, I say: let's upgrade Ruby.

AntoineTheb commented 4 years ago

Alright !

nathanpainchaud commented 4 years ago

IMO, it would be worth it to upgrade to the latest Ruby (2.7.1) to ensure we won't have to do it again for as long as possible.

lemairecarl commented 4 years ago

@AntoineTheb That's when the version in Gemfile.lock was changed: https://github.com/vitalab/vitalab.github.io/pull/493

which is ok.

Indeed, let's go with the latest stable version.