Possible incompatibility with Jekyll 4.0.0

[paulocoghi]

Description:

It seems that jekyll-admin isn't proper configured to run with Jekyll 4.0.0.

Tell us a bit about yourself:

• Version of JekyllAdmin: v0.8.1
• Version of Jekyll: possibly v4.0.0 (because bundle show also returns the same error)
• Version of NodeJS: v12.7.0
• Operating System: Ubuntu 18.04 64bits

Steps to reproduce:

After correctly installing Jekyll on my computer and running a test instance with no issues, I created the _plugins directory and installed Jekyll Admin through:

• adding - jekyll-adminto the "plugins" section on _config.yml
• running gem install jekyll-admin
• adding it to the :jekyll_plugins group in the Gemfile
• and, finally, running bundle install
• tried to run bundle exec jekyll serve

I expected the following:

I expected to receive no errors, to be able to go to http://localhost:4000/admin

But got the following, instead:

When running bundle exec jekyll serve, it returns:

Bundler could not find compatible versions for gem "jekyll":
  In snapshot (Gemfile.lock):
    jekyll (= 4.0.0)

  In Gemfile:
    jekyll (~> 4.0.0)

    jekyll-admin was resolved to 0.8.1, which depends on
      jekyll (~> 3.3)

Running `bundle update` will rebuild your snapshot from scratch, using only
the gems in your Gemfile, which may resolve the conflict.

Other details:

The error persists even after running bundle update

[mattboy9921]

I also have this issue. I've just tried using Bundler in a fresh folder to install Jekyll. Then, I add gem 'jekyll-admin', group: :jekyll_plugins to my Gemfile and get the same error as OP when running bundle install. Only difference is mine says jekyll-admin was resolved to 0.1.1, which depends on jekyll (~> 3.1).

[paulocoghi]

@mattboy9921 , I tried to update Jekyll Admin using bundle update to see if a newer version would be compatible with Jekyll 4.0.0.

This is possibly the reason that my last error informs the version 0.8.1 to Jekyll Admin instead of 0.1.1

[mattboy9921]

After some more messing around, I've learned that the newest version of Jekyll that jekyll-admin works correctly on is 3.8.6. 4.0.0 and the alpha/beta result in that same error message. To be clear, I've just been changing the version in my Gemfile and running bundle update. I can't find any documentation stating version compatibility.

Edit:
Looking here: https://github.com/jekyll/jekyll-admin/blob/24e5a4ef3e65ecea5b0cb0fb0949dab71f21746f/jekyll-admin.gemspec#L30
spec.add_dependency "jekyll", "~> 3.3" would indicate (with my limited knowledge about Ruby and gems, that it depends on Jekyll 3.3 to 3.9 but nothing higher. Again, not completely certain on the ~> operator.

[ashmaroli]

Yes @mattboy9921 you're correct.
~> 3.3 means allow all versions in the 3.x series starting from 3.3.0
However, ~> 3.3.0 would mean allow only versions in the 3.3.x series starting from 3.3.0

[mattboy9921]

Alright, I've managed to get jekyll-admin to work on Jekyll 4.0.0. It's a silly, hacky way to do it but it does work.

1. Edit your Gemfile Jekyll version to 3.8.6 and make sure jekyll-admin is in the plugin section.
2. Run bundle update to get everything downloaded and working.
3. Assuming you've installed Jekyll with Bundle via the tutorial on Jekyll's site, cd into ./vendor/bundle/ruby/2.5.0/specifications and edit jekyll-admin-0.8.1.gemspec so both instances of jekyll have their version set to 4.0.0.
4. cd back to your Jekyll site directory and edit your Gemfile so Jekyll is at 4.0.0.
5. Run bundle update again. It didn't redownload everything, just Jekyll so the changes to jekyll-admin's dependencies stuck. I also noticed there is a --local option for bundle update which forces using local cache but I didn't try it.

Doing this, I can now have Jekyll 4.0.0 with jekyll-admin and so far, I can't find any issues. So maybe this is just a matter of updating the dependency string to include 4.0.0?

[derekhe]

Please help to support 4.0

[lexoyo]

It should be well tested but I believe we just need to add something like , ">= 4.0.0" in the gemfile. Would someone do a Pull Request? I can help you with the git part maybe?

[ashmaroli]

Guys, there's already a PR for this: #492
Unlike other plugins in the Jekyll ecosystem, this plugin contains a "front end" version based on ReactJS and Node modules which are compiled at release (or while testing).

So, you need to build the gem from source with the required Node modules and can't just point your Gemfile to the GitHub repo and expect it to work..

[lexoyo]

My bad, I'll make a review now

[shanebdavis]

Guys, there's already a PR for this: #492

What is blocking on this PR getting accepted? I have some time to commit to open-source. I'd be happy to help out to get jekyll-admin updated for jekyll 4.0. @benbalter @mertkahyaoglu @ashmaroli

Thanks for the great project! Hope I can help bring it up-to-date.
-Shane

[ashmaroli]

jekyll-admin-0.9.0 with support for Jekyll 4.0 has been released.