search

github / pages-gem

A simple Ruby Gem to bootstrap dependencies for setting up and maintaining a local Jekyll environment in sync with GitHub Pages
http://pages.github.com
MIT License
1.83k stars 353 forks source link

Update docs or dependencies to include installing `webrick` #864

Open yuletide opened 1 year ago

yuletide commented 1 year ago

With a fresh install on mac using chruby, ruby ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [arm64-darwin21] (as suggested by jekyll docs) and github-pages (227) the command for jekyll serve fails complaining about missing webrick. Adding this to the Gemfile fixes the issue.

Before submitting an issue, please be sure to

This issue affects

The GitHub Pages Gem is intended to help users replicate the GitHub Pages build environment locally. If your issue affects both the hosted version and the version previewed locally, you may be better suited reporting seeking support in other forums.

What did you do (e.g., steps to reproduce)

Followed the docs

What did you expect to happen?

jekyll serve to work

What happened instead?

This error https://github.com/jekyll/jekyll/issues/8523

Additional information

parkr commented 1 year ago

Followed the docs

Which docs, specifically?

hartsick commented 1 year ago

I ran into this same issue following these docs: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll

solvaholic commented 1 year ago

Duplicate of https://github.com/github/pages-gem/issues/752

/cc https://github.com/github/pages-gem/issues/752#issuecomment-764758292:

Hi! In general, we recommend (and support) running the github-pages gem with the Ruby version we're running in production (2.7.x). We don't yet support Ruby 3.0.0. Ruby 2.7.x still has webrick so I'd recommend using that until we've upgraded for your GitHub Pages needs!

janbrasna commented 8 months ago
  1. https://jekyllrb.com/docs/#instructions has the note since:
  2. https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll#building-your-site-locally has the note since:
  3. so it's just the readme here like https://github.com/github/pages-gem/pull/881 missing it…
janbrasna commented 2 months ago

This should be resolved as of v232.