actions / actions/starter-workflows
jekyll.yml starter workflow has end of life ruby version that causes errors
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 12.1k
- Forks
- 7.3k
- PR merge metrics
- No merged PRs in 30d
Description
The starter workflow for Jekyll site build, "jekyll.yml", line 40 lists ruby-version: '3.1'. Ruby 3.1 is no longer supported. It causes errors when the action runs that are hard to debug and cause people to go deep into unrelated fixes. To avoid the errors the most basic fix is just to update the ruby version to 3.4, ruby-version: '3.4'. I have tested this with dozens of projects.
PR #3296 mentions out of date setup-ruby which could also be updated at the same time, but is not necessary to avoid errors.
This is an important action to update because thousands of people still use it to build Jekyll sites on github pages.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open pages/jekyll.yml and inspect the ruby-version entry at line 40. Update the starter workflow to Ruby 3.4, then verify the Jekyll workflow no longer uses the end-of-life Ruby version or produces the reported errors; updating setup-ruby is optional.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, jekyll, ruby
- Domain
- ci-cd
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100