You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
short_description: 'Update your Gemfile to avoid Jekyll issues with latest Ruby releases.'
9
+
---
10
+
11
+
As of January 2025, if you are running the most recent stable Ruby version (3.4.0+) and the current version of Jekyll (4.3.4), you might encounter errors when using `bundle install jekyll s` on existing projects!
12
+
13
+
There is a bunch of changes to the standard library in the new versions of Ruby (3.4.0+).
14
+
The current version of Jekyll hasn't caught up with adding all the requirements to their dependencies yet, so if you are running a recent version of Ruby you may be getting a lot of warnings messages in the terminal--or worse, if you have the fresh current stable version ruby 3.4.1, you will get weird error messages on `bundle exec jekyll s` and it won't run at all.
15
+
16
+
The required dependencies are now added the the CB-CSV "Gemfile" (as of Jan 8th, 2025), so fresh collections should be fine!
17
+
18
+
If you run into the issue with an existing project (on your freshly installed new ruby):
19
+
20
+
- Delete the "Gemfile" and "Gemfile.lock" in your repository
21
+
- Add a copy of the new ["Gemfile" from collectionbuilder-csv](https://github.com/CollectionBuilder/collectionbuilder-csv/blob/main/Gemfile)
short_description: 'Issue with GitHub Actions can cause errors building sites.'
9
+
---
10
+
11
+
As of January 2025 there is a *currently a bug in the default GitHub Actions "jekyll.yml" starter workflow!*
12
+
13
+
Due to [changes in the ubuntu-latest image](https://github.com/actions/runner-images/issues/10636), the GitHub Action will end up with errors in existing and new repositories using the workflow--i.e. if you set up a CB-CSV site and are building it with the default GitHub Actions, new builds will likely fail with errors going forward!
14
+
15
+
Please note that we do not maintain the "jekyll.yml" or GitHub Actions so can not directly fix the default starter workflow.
16
+
17
+
To fix it in your project, edit the file ".github/workflows/jekyll.yml" in your repository. There is two possible ways to fix it.
18
+
19
+
The first option is to update the `setup-ruby` version.
*Alternatively*, the second option is to roll back the image used by your action.
31
+
On line 32, replace:
32
+
33
+
`runs-on: ubuntu-latest`
34
+
35
+
with:
36
+
37
+
`runs-on: ubuntu-22.04`
38
+
39
+
This will restore it to the older image which still works correctly.
40
+
41
+
*(you only need one of these options to fix the issue!)*
42
+
43
+
There is an [Issue in the CollectionBuilder-CSV repository](https://github.com/CollectionBuilder/collectionbuilder-csv/issues/96) and a note in the [documentation](https://collectionbuilder.github.io/cb-docs/docs/deploy/actions/) tracking this problem.
44
+
45
+
Eventually, we assume someone will fix the default "jekyll.yml"... However, existing repositories may require this manual fix.
Copy file name to clipboardExpand all lines: _posts/2025-01-10-january-roundup.md
+8-26Lines changed: 8 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ layout: post
3
3
title: 'CollectionBuilder Bulletin: January 2025'
4
4
subtitle:
5
5
author: Devin Becker
6
-
publish-date: January 10, 2024
6
+
publish-date: January 10, 2025
7
7
tags: [newsletter]
8
8
short_description: 'A round-up for January 2025.'
9
9
---
@@ -12,23 +12,23 @@ Hi Everyone,
12
12
We have **a lot of updates** with the new year. The team went for a retreat in
13
13
November to beautiful McCall, Idaho. Evan made us watch a hockey game (which ended up being amazing) and we got a lot of work done, both on the core of CollectionBuilder and on some new features.
14
14
15
-
And then in less fun news, Evan's been discovering issues with an update to the Jekyll action that builds CollectionBuilder-CSV websites on GitHub and with the latest Ruby update. No worries we have fixes (see below), but both issues will likely cause some frustration unfortunately.
15
+
And then in less fun news, Evan's been discovering issues with an update to the GitHub Actions Jekyll workflow that builds CollectionBuilder-CSV websites on GitHub and with the latest Ruby update. No worries we have fixes (see below), but both issues will likely cause some frustration unfortunately.
16
16
17
17
As always, If you have a project and/or event you’d like us to highlight next month please email [collectionbuilder.team@gmail.com](mailto:collectionbuilder.team@gmail.com).
18
18
19
19
\- The CollectionBuilder Team (Devin writing this ...)
20
20
21
21
## **This month’s news:**
22
22
23
-
### We took a retreat\!
23
+
### We took a retreat!
24
24
25
25
The CollectionBuilder Team took a short retreat during which we worked on some long standing issues and developed some new features.
26
26
27
27
**Boring (but Important) Updates to CB-CSV:** The CollectionBuilder-CSV repository received several minor, non-breaking updates last week during a team retreat, including:
28
28
29
29
- normalized and documented Index includes
30
30
- a significant reorganization of Rake tasks into a dedicated "rakelib/" folder for improved manageability.
31
-
- Several new utility tasks were also added for working with objects, including download_by_csv, rename_by_csv, rename_lowercase, and resize_images, with corresponding documentation available in the docs/rake_tasks directory.
31
+
- Several new utility tasks were also added for working with objects, including download_by_csv, rename_by_csv, rename_lowercase, and resize_images, with corresponding documentation available in the "docs/rake_tasks" directory.
32
32
33
33
These updates are currently only available in the main branch of CB-CSV and are intended for new projects, with no need to update existing implementations unless new functionality is desired. While more substantial changes with breaking updates are in development, these modifications are currently exclusive to CB-CSV, with plans to eventually roll out compatible changes to CB-GH and CB-Sheets platforms.
34
34
@@ -41,30 +41,12 @@ We also built some cool things, several of which are not quite ready for prime t
41
41
-***a revised about page*** -- Olivia is working on a major revision of the about page that automatically generates a table of contents at the top right and changes the basic size of the text block. It looks a lot better and we're excited to roll that out this spring.
42
42
-***a cb-essay repository***-- I've been working on a repository that takes some of Evan's work on [Fire Lines](https://cdil.lib.uidaho.edu/fire-lines/) and some of my work with a recent CDIL fellow (CDIL is our DH center at the University of Idaho) that will help people use CollectionBuilder to publish long form essays with a collection underneath. There will be options for stepping through the essay and also for a scroll-based experience -- you can see a example of how that should work in [an essay on our new project Keeping Watch](https://cdil.lib.uidaho.edu/keeping-watch/essay/).
43
43
44
-
### There are some breaking issues with new releases (not our fault!)
44
+
### There two breaking issues (not our fault!)
45
45
46
-
***Issues with the latest GitHub Jekyll Action**\-
47
-
48
-
There is currently an issue with the default GitHub Action for Jekyll that causes build errors for both new and existing repositories following CollectionBuilder's deployment instructions. Two temporary solutions are available:
49
-
50
-
If you want to manually fix it for now--> in your repository, edit the file ".github/workflows/jekyll.yml". Go to line 32, where it says `runs-on: ubuntu-latest` and replace it with `runs-on: ubuntu-22.04`
51
-
52
-
This will restore it to the older image which still works correctly!
53
-
54
-
You can also update the ruby/setup-ruby version to use: ruby/setup-ruby@v1.207.0 (line 37).
55
-
56
-
This issue has been documented in the [CollectionBuilder-CSV repository](https://github.com/CollectionBuilder/collectionbuilder-csv/issues/96) and added to the [documentation](https://collectionbuilder.github.io/cb-docs/docs/deploy/actions/).
57
-
58
-
Eventually, we assume someone will fix the default "jekyll.yml" ...
59
-
60
-
***Issues with the latest Ruby release**\-
61
-
62
-
An issue has emerged with Jekyll compatibility in Ruby versions 3.4.0 and above, where Jekyll's dependencies haven't been updated to match Ruby's standard library changes. Users running recent Ruby versions may experience warning messages in the terminal, while Ruby 3.4.1 users may encounter errors preventing Jekyll from running (bundle exec jekyll s). To resolve this, CollectionBuilder-CSV's Gemfile has been updated with the required dependencies.
63
-
64
-
**For existing projects** experiencing these issues, users should delete their current "Gemfile" and "Gemfile.lock" files and replace them with the updated Gemfile from CollectionBuilder-CSV (https://github.com/CollectionBuilder/collectionbuilder-csv/blob/main/Gemfile).
65
-
66
-
New collections using the latest CB-CSV template should work without modification.
46
+
Two new issues that CB users are probably encountering:
67
47
48
+
- An update to GitHub Actions is causing build errors that impact anyone using the default "jekyll.yml" workflow--i.e. if you are building CB-CSV on GitHub, you are probably impacted! Check the [GitHub Actions Bug blog post for fixes](https://collectionbuilder.github.io/2025-01-09-gh-pages-issue/)
49
+
- Jekyll is having issues with the most recent Ruby versions. The CB-CSV template's "Gemfile" has been updated to fix the problem, but you may encounter errors if building an older project with a fresh Ruby install. Check the [ blog post for info](https://collectionbuilder.github.io/2025-01-08-gemfile-update/).
0 commit comments