se-edu / addressbook-level3

:ab::three: Address Book sample application (Level 3)
https://se-education.org/addressbook-level3
MIT License
27 stars 411 forks source link

[#182] Local github page deployment fails on Ruby >=3.0 #185

Closed Eclipse-Dominator closed 1 year ago

Eclipse-Dominator commented 1 year ago

Fixes #182

Running bundle exec jekyll serve to test GitHub page deployment will fail due to a compatibility issue with Jekyll 3 and Ruby >=3.0.

Let's resolve this by

canihasreview[bot] commented 1 year ago

Click here to submit a new iteration when this PR is ready for review.

See this repository's contribution guide for more information.

canihasreview[bot] commented 1 year ago

v1

@Eclipse-Dominator submitted v1 for review.

(:books: Archive)

Checkout this PR version locally ```sh git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/185/1/head:BRANCHNAME ``` where `BRANCHNAME` is the name of the local branch you wish to fetch this PR to.
codecov[bot] commented 1 year ago

Codecov Report

Merging #185 (b2d03aa) into master (481a3d9) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #185   +/-   ##
=========================================
  Coverage     72.06%   72.06%           
  Complexity      399      399           
=========================================
  Files            70       70           
  Lines          1235     1235           
  Branches        127      127           
=========================================
  Hits            890      890           
  Misses          314      314           
  Partials         31       31           

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

canihasreview[bot] commented 1 year ago

v2

@Eclipse-Dominator submitted v2 for review.

(:books: Archive) (:chart_with_upwards_trend: Interdiff between v1 and v2) (:chart_with_upwards_trend: Range-Diff between v1 and v2)

Checkout this PR version locally ```sh git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/185/2/head:BRANCHNAME ``` where `BRANCHNAME` is the name of the local branch you wish to fetch this PR to.
damithc commented 1 year ago

No further comments on the fix but a couple of questions, mostly out of curiosity.

Eclipse-Dominator commented 1 year ago

I think prior to ruby 3.0, "webricks" package is installed by default. That's why after ruby 3.0, jekyll server will fail since they can no longer find the webricks package.

I think those were the version numbers after I updated ruby packages. I think I can fine tune the versions more? Alternatively, just removing gem.lock file and let the users install the latest version will work as well

damithc commented 1 year ago

I have no further comments on this PR. I also don't know enough about Jekyll to decide whether we should keep gem.lock in the repo or remove it. @se-edu/tech-team-level1 feel free to weigh in.

damithc commented 1 year ago

Thanks for the fix @Eclipse-Dominator Note that I edited the commit message slightly, to explain the reason for the crash so that the reason for the change is evident.