Skip to content

Cannot run Jekyll locally for GitHub Pages with latest Ruby #44808

@david-kudlacek

Description

@david-kudlacek

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll

What part(s) of the article would you like to see updated?

I followed the article and had trouble setting up Jekyll to run locally with GitHub Pages because I had a newer version of Ruby installed (4.0.5). I would like to suggest adding a mention that Ruby 3.2 or later breaks compatibility with the github-pages gem. The issues I've encountered when running the bundle exec jekyll serve command are:

  1. Missing csv and bigdecimal gems (since Ruby 3.4 they are no longer default).
  2. Nonexistent tainted?, taint and untaint methods (since Ruby 3.2).
  3. A broken 'pathutil' gem which needed a specific ref in the Gemfile to work.

I installed an earlier version of Ruby (3.1.2) and could run bundle exec jekyll serve just fine with the github-pages gem in my Gemfile. I believe adding a note would save others time from trying to fix issues on a newer version of Ruby when they could just install an earlier one like 3.1.x.

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the team

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions