Skip to content

Mention Ruby/Dev Minimum Requirements in README #49

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
dzoladz opened this issue Nov 18, 2021 · 7 comments
Closed

Mention Ruby/Dev Minimum Requirements in README #49

dzoladz opened this issue Nov 18, 2021 · 7 comments

Comments

@dzoladz
Copy link
Member

dzoladz commented Nov 18, 2021

If our site requires a minimum version of Ruby, we should mention that in the README.md file.

From Slack:

Probably mention needing Ruby 2.6 at least. Jekyll doesn't work with Ruby 3 either.

In fact, at least 2.6.3 per this site saying "Ruby 2.6.3 includes a version of RubyGems that’s less strict, so upgrading Ruby will automatically upgrade RubyGems and should fix the issue too."

@phette23
Copy link
Member

I thought a bit about this last night and was thinking maybe from the readme we should link to a wiki page with "known working configurations" and where to go to get help if you still cannot build the site. I'm on ruby 2.5.7 and it's working, so I don't necessarily think ruby version is a strict limitation, there are probably several factors and rather than spend a lot of time identifying them we could just list our various setups and how we got the site to build.

@metageeky
Copy link
Contributor

Well, that narrows it down a bit. Ruby 2.5.1 was not sufficient. But yes, known working configurations is a good idea and perhaps limitations like how Jekyll currently doesn't support Ruby 3 (at least according to what I read while debugging my build yesterday).

@phette23
Copy link
Member

phette23 commented Dec 3, 2021

Created a Known Working Configurations wiki page and added my own.

@phette23
Copy link
Member

phette23 commented Dec 3, 2021

@yarnetsky Derek said you might have an Apple M1 laptop? And/or a windows machine? If you have the site building on either of those could you add an overview of how you got it working to the wiki page I linked in my last comment?

@yarnetsky
Copy link
Contributor

yarnetsky commented Dec 3, 2021

Lately I've been using a Github Codespaces VM. I did get it to build on Windows by adding a couple more gems. Never got it to run on my M1 due to dependencies unavailable for the arm chip. I'll double check everything on Monday or Tuesday (I have some urgent grading to knock out first) and will add my configs.

@dzoladz
Copy link
Member Author

dzoladz commented Feb 9, 2022

Installed rbenv this evening and successfully built the site using Ruby 3.0.0 on macOS Big Sur.

ruby 3.0.0p0 (2020-12-25 revision 95aff21468) [x86_64-darwin20]

@dzoladz
Copy link
Member Author

dzoladz commented Feb 19, 2022

Updated the wiki with a direct link to the build configurations that are known to work

@dzoladz dzoladz closed this as completed Feb 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants