Skip to content
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

Support for Jekyll 4.0 #651

Open
janko opened this issue Aug 20, 2019 · 56 comments
Open

Support for Jekyll 4.0 #651

janko opened this issue Aug 20, 2019 · 56 comments

Comments

@janko
Copy link
Contributor

@janko janko commented Aug 20, 2019

Jekyll 4.0.0 is out, and brings lots of nice improvements. It would be really nice if github-pages gem would add support for Jekyll 4.

@fsimonis
Copy link

@fsimonis fsimonis commented Aug 21, 2019

Noteworthy is the upgrade of jekyl-sass-converter to version 2.
They switched from Ruby Sass to csass, as the former has reached end-of-life:

Post-install message from sass:

Ruby Sass has reached end-of-life and should no longer be used.

* If you use Sass as a command-line tool, we recommend using Dart Sass, the new
  primary implementation: https://sass-lang.com/install

* If you use Sass as a plug-in for a Ruby web framework, we recommend using the
  sassc gem: https://github.com/sass/sassc-ruby#readme

* For more details, please refer to the Sass blog:
  https://sass-lang.com/blog/posts/7828841

@polyrain
Copy link

@polyrain polyrain commented Sep 24, 2019

Can we get an update on this?

@wigging
Copy link

@wigging wigging commented Oct 13, 2019

I am also awaiting Jekyll v4.0 support for Github Pages. I need to use the "manually order documents" feature for collections but it is only available in v4.0. https://jekyllrb.com/docs/collections/#manually-ordering-documents

@DirtyF
Copy link
Contributor

@DirtyF DirtyF commented Oct 13, 2019

I'd recommend using GitHub Actions to build your site and publish it on GitHub Pages: https://github.com/BryanSchuetz/jekyll-deploy-gh-pages

@kushalpandya
Copy link

@kushalpandya kushalpandya commented Oct 14, 2019

I didn't have any dependency on Jekyll 4.0 except for better SCSS compile performance (due to sassc), but I ditched GitHub Pages in favour of Netlify as it can even install 3rd-party Jekyll plugins which aren't supported by GitHub, and you get all the features that GitHub Pages provides + a few extra for free!

@DirtyF
Copy link
Contributor

@DirtyF DirtyF commented Oct 14, 2019

Please note that Netlify recently limited their free plan to 300min build per month, aka 10min per day.

@wigging
Copy link

@wigging wigging commented Oct 14, 2019

In the past, how long did it take for GitHub Pages to update to the latest version of Jekyll? Or is GitHub Pages always on an old Jekyll version?

@kushalpandya
Copy link

@kushalpandya kushalpandya commented Oct 14, 2019

Please note that Netlify recently limited their free plan to 300min build per month, aka 10min per day.

I think 10 min per day is sufficient for most users who are using GitHub Pages where they don't update their site as often each day. In my case, I have a moderately complex site with 50+ documents and a handful of 3rd party jekyll plugins and yet the site builds gets published under 40 seconds on Netlify. So hitting that 10 minute limit for the day would be distant. 😅

In the past, how long did it take for GitHub Pages to update to the latest version of Jekyll? Or is GitHub Pages always on an old Jekyll version?

I think upgrade to 4.0 is going to take some time as it being a major upgrade with 1 breaking change around how post_url behaves as GitHub wouldn't want a lot of broken static sites with such an upgrade. Not to mention that many repos which use GH Pages don't have Gemfile present (myself included when I used Jekyll for the first time to build my portfolio) which is going to affect them with upgrade.

monsteronfire added a commit to RapidRiverSoftware/rapidriversoftware.github.io that referenced this issue Oct 16, 2019
* Will be updated for github-pages when Jekyll version is bumped up to 4
* github/pages-gem#651
monsteronfire added a commit to RapidRiverSoftware/rapidriversoftware.github.io that referenced this issue Oct 16, 2019
monsteronfire added a commit to RapidRiverSoftware/rapidriversoftware.github.io that referenced this issue Oct 17, 2019
@brando90
Copy link

@brando90 brando90 commented Oct 28, 2019

what is the progress for this? Is there support for Jekyll 4?

calumhalcrow pushed a commit to RapidRiverSoftware/rapidriversoftware.github.io that referenced this issue Nov 4, 2019
@kimchirichie
Copy link

@kimchirichie kimchirichie commented Nov 20, 2019

As a new user to Jekyll, i am unsure how to post to github pages without the 4.0 support. Would anyone have any suggestions on which previous version i should be using? My bundler says

 github-pages was resolved to 4, which depends on
      jekyll (= 1.1.2)

which doesnt seem right. Regardless, I've given that a try by lowering jekyll@v1.1.2 which is when I ran into issues with jekyll-feed not being supported at jekyll@v1.1.2. So I removed that and got

An error occurred while installing yajl-ruby (1.1.0), and Bundler cannot continue.
Make sure that `gem install yajl-ruby -v '1.1.0' --source 'https://rubygems.org/'` succeeds before bundling.

Ugh... It would be nice to use jekyll@v4.0 but for the time being, which version should I use? Is there a branch that supports jekyll@v4.0?

@kimchirichie
Copy link

@kimchirichie kimchirichie commented Nov 20, 2019

after a bit of hair pulling, I ACTUALLY read the comments in the Gemfile and commented out the gem jekyll and uncommented github-pages as instructed. hopefully someone finds my findings useful down the road.

# gem "jekyll", "~> 4.0.0"
group :jekyll_plugins do
  gem "jekyll-feed", "~> 0.11"
  gem "github-pages", "202"
end

P.S. jekyll-feed needs to be downgraded from v0.12 to v0.11 and github-pages needs to be told v202

@bguiz
Copy link

@bguiz bguiz commented Dec 18, 2019

Jekyll 4 has added support for binary operators within where_exp, and I would like to use this feature. Can we please get a release of github-pages that works with Jekyll 4 pls?

BTW @kimchirichie thanks for this comment - that works out on localhost, but unfortunately not on our particular CI/CD setup - so still need a new release of this page.

EDIT: Quite a few people asking for it here plus a whole bunch of related questions on Stackoverflow.

bguiz added a commit to rsksmart/devportal that referenced this issue Dec 18, 2019
… their titles

- NOTE the jekyll `where_exp` filter does not support `and` in 3.8.5
  - support has been added in 4.0.0, but cannot upgrade due to `github-pages` gem dependecny
  - see jekyll/jekyll#6998
  - see github/pages-gem#651 (comment)
@hoff2-ACN
Copy link

@hoff2-ACN hoff2-ACN commented Dec 18, 2019

Not sure if this is any help but I suspect one could do a jekyll 4 build in a github action now. Seems plausible enough to look into whether someone's already done it, in fact. Been trying to make time to give it a shot myself.

@sujaykundu777
Copy link

@sujaykundu777 sujaykundu777 commented Jan 18, 2020

@hoff2-ACN I have built a Theme using Github Pages and Github Actions with the latest Bundler and Jekyll 4.0.0 out of the box, soon will be sharing the tutorial which can be used to deploy your Blog using Jekyll 4 !! 👍
Here it is 🍡 - Deploy Jeyll Blog using Github Actions with Jekyll 4

@hoff2-ACN
Copy link

@hoff2-ACN hoff2-ACN commented Jan 20, 2020

@sujaykundu777 fantastic! thank you so much!

@jdickey
Copy link

@jdickey jdickey commented Feb 1, 2020

So, with people either going to GitHub Actions or to Netlify, are we to assume that GitHub no longer cares about the traditional write/commit/push-and-publish workflow? This issue has been open well over five months, and four since a committer to this repo (@DirtyF) left a comment.

There are clearly a number of people waiting/hoping that one of the very few who are familiar with the codebase (if I'm reading this chart right, about 3 people) can either perform the (apparently non-trivial) updates needed to close this issue or open a PR with enough information for one or more of us tyros to get started.

Are we waiting for Godot?

@DirtyF
Copy link
Contributor

@DirtyF DirtyF commented Feb 1, 2020

Disclaimer: I don't work for GitHub, nor am a maintainer for this gem.

The update is indeed non-trivial, as there are breaking changes and some impacting issues were raised since Jekyll 4.0 was released, due to the new cache API, so it's safer for GitHub not to upgrade to Jekyll 4.0 for now, as they don't want to break existing websites.

As this was already mentioned before, GitHub Actions are the way to go if you want to use a custom Jekyll or plugins at your own risk.

I don't have proper rights on this repository, but this issue should be closed for now, as it won't happen anytime soon, no need to give people false hopes. GitHub should come with a proper documentation on how to run Jekyll on GitHub Pages with GitHub Actions.

@jdickey
Copy link

@jdickey jdickey commented Feb 3, 2020

Sorry, @DirtyF, I misunderstood your relationship to the project (and possibly GitHub) from the quality of the comments you'd left earlier.

Actions sans this Gem sound like The Way Forward for those of us who'd like to take advantage of Jekyll 4 (and future versions). Thanks again.

@DirtyF
Copy link
Contributor

@DirtyF DirtyF commented Feb 3, 2020

On a side note; remote-theme plugin is now supoprting Jekyll 4.0 : https://github.com/benbalter/jekyll-remote-theme/releases/tag/v0.4.2

@twsl
Copy link

@twsl twsl commented May 22, 2021

Any updates? Can't we just merge #745 ?

@wigging
Copy link

@wigging wigging commented May 22, 2021

It's been more than 1.5 years since Jekyll 4.0 came out. I don't think GitHub will ever update GitHub Pages to support the latest Jekyll version.

@runxel
Copy link

@runxel runxel commented May 24, 2021

It's been more than 1.5 years since Jekyll 4.0 came out. I don't think GitHub will ever update GitHub Pages to support the latest Jekyll version.

Which in itself would not be dramatic, but the lack of recognition and official answers here is.
Bad, bad communication. 👎

@br3nt
Copy link

@br3nt br3nt commented Jul 18, 2021

Who wants Jekyll 4?? We want Jekyll 4!! When I say Jekyll, you say 4! Jekyll!! Github Team: 3!

@alantbarlow
Copy link

@alantbarlow alantbarlow commented Jul 29, 2021

I need Jekyll 4 support to prioritize includes over excludes in the config file. It's been 2 years since its release and no one has even been assigned to this issue.

@yaitskov
Copy link

@yaitskov yaitskov commented Aug 13, 2021

Please remove constraint on gem versions.
You wont be able to keep up.

@hansfn
Copy link

@hansfn hansfn commented Aug 17, 2021

As suggested earlier adding support for the current version of Jekyll (without breaking all existing sites on Github Pages), could be as easy as adding a file .useCurrentJekyll (similar to .nojekyll) to enable it.

Anyway, an official reply from Github would be nice. I tried to make some noise on Twitter 😆

@janderssonse
Copy link

@janderssonse janderssonse commented Aug 17, 2021

I commented on their latest changelog post on linkedin and asked about attention to this issue. :)

@brutallyminimal
Copy link

@brutallyminimal brutallyminimal commented Oct 30, 2021

This works very well for me for deploying Jekyll 4+ to Github pages - https://jekyllrb.com/docs/continuous-integration/github-actions/

@hh-lohmann
Copy link

@hh-lohmann hh-lohmann commented Nov 5, 2021

DirtyF said on Feb 1, 2020 what has to be said (see above, shortcut #651 (comment)), so close this and other threads by appropriate information, eg. "We at GitHub regard Jekyll 4.x not as an update of Jekyll, but as a separate program, that, as many separate programs, is supported by Actions". Jekyll was always, reasonably, restricted at GitHub, maybe they should officially label a "GitHub Flavored Jekyll", like "GitHub Flavored Markdown" that had, eg., no footnotes until recently (https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/).

(btw if you didn't know: https://jekyllrb.com/news/2021/09/14/goodbye-dear-frank/ (=DirtyF))

@AntonyLeons
Copy link

@AntonyLeons AntonyLeons commented Jan 22, 2022

The solution here is to remove the github pages gem and add any missing dependacies by hand. Then you can ise a CI/CD service like netlify or upload your html pages from your build folder.

old GemFile:

source "https://rubygems.org"

gem "jekyll", "~> 3.8.5"
gem 'jekyll-feed'
gem 'github-pages', '~> 206'
gem 'rake', '~> 13.0'
gem 'wdm', '~> 0.1.1'

new Gemfile:

source "https://rubygems.org"

gem 'jekyll', '~> 4.2', '>= 4.2.1'
gem 'jekyll-paginate', '~> 1.1'
gem 'jekyll-feed', '~> 0.16.0'
gem 'jekyll-sitemap', '~> 1.4'
gem 'rake', '~> 13.0', '>= 13.0.6'
gem 'wdm', '~> 0.1.1'

This is just pushing you to use a service like github actions though, probably why they refuse to update this.

mnh48 added a commit to mnh48/guild.mnh48.moe that referenced this issue Mar 31, 2022
- It seemed that GitHub Pages did not update their Jekyll to v4
  yet (ref. github/pages-gem#651) and so the load order of files
  from _data is so random and out of place even though I had
  specified the number order in the filename itself, so I'm making
  for-loop-based checking to ensure they are in the correct order.
  I hope this will finally fix the actual ordering issue.
grdryn added a commit to grdryn/architecture that referenced this issue May 9, 2022
GitHub pages has been stuck for years on an old version of
Jekyll. Updating their convenience tooling to Jekyll 4 would break a
lot of existing sites, so it probably will never happen. See here for
more info: github/pages-gem#651

It turns out that we're already using the Jekyll GitHub Action (I'm
not sure what the reason we were doing that already is), so there's
little reason not to upgrade.

This change also removes a workaround that no longer seems necessary
with the new Jekyll version.
wtrocki pushed a commit to bf2fc6cc711aee1a0c2a/architecture that referenced this issue May 12, 2022
* Change _config.yml away from DOS line endings

To sanity check, review on GitHub with `?w=1` url param, or locally
with `git diff --color-words`.

* Migrate Gemfile from github-pages to Jekyll 4.2.2

GitHub pages has been stuck for years on an old version of
Jekyll. Updating their convenience tooling to Jekyll 4 would break a
lot of existing sites, so it probably will never happen. See here for
more info: github/pages-gem#651

It turns out that we're already using the Jekyll GitHub Action (I'm
not sure what the reason we were doing that already is), so there's
little reason not to upgrade.

This change also removes a workaround that no longer seems necessary
with the new Jekyll version.

* Update workflow to cache deps, per action docs

I'm not 100% sure how much this saves, but the docs for the action
mention it in the example:
https://github.com/marketplace/actions/jekyll-actions

* Convert README to asciidoc

Seems reasonable, given this repo is primarily asciidoc-based. :)

* Add instructions for building in a container

* Remove broken include to clear build error

* Enable Liquid pre-processing in adr-process.adoc

See here for more info:
https://github.com/asciidoctor/jekyll-asciidoc/#enabling-liquid-preprocessing

Fixes #49 by causing the template variables to be processed.
@pensierinmusica
Copy link

@pensierinmusica pensierinmusica commented Jun 15, 2022

@parkr @benbalter @yoannchaudet @felipesu19 any chance GitHub pages upgrade Jekyll >= 4.0 ?

It's been a long time now, and there are features needed.

@yoannchaudet
Copy link
Contributor

@yoannchaudet yoannchaudet commented Jun 15, 2022

We are looking at ways to support Jekyll 4+ but not this way.

I promise you exciting things are coming. We just need a little bit more time on our side (a few weeks).

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