remove path flag in Jekyll build

[valeriupredoi]

Pull Request checklist

Attempt fix for #419 as reported by @schlunma

@LisaBock @rswamina @hb326 this also fixes the issue with the disallowed string format and I cranked up the max line length so the checker stops failing.

Before you start

• Read CONTRIBUTING.md.
• Create an issue to discuss your idea. This allows your contributions to be incorporated into the tutorial.

Tasks

• Give this pull request a descriptive title.
• If you are contributing to existing lesson materials, please make sure the content conforms to the Lesson development section in CONTRIBUTING.md and does not contain any spelling or grammatical errors.
• If you are making a new episode, please make sure the content conforms to the Lesson organization and Lesson formatting sections in CONTRIBUTING.md and does not contain any spelling or grammatical errors.
• Preferably Codacy checks pass. Status can be seen below your pull request. If there is an error, click the link to find out why.
• Preview changes on your machine before pushing them to GitHub by running make serve, alternatively make docker-serve. Please see the Previewing your changes locally section in CONTRIBUTING.md for installation instructions.
• All code instructions have been tested.

If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.

---

Closes {Link to the corresponding issue}

[schlunma]

Did you try this locally with a fresh conda environment? I don't trust the CI tests on this one. As far as I can tell, the actual deployment of the website does not use a conda environment, so we need to test that this actually works within an environment.

[valeriupredoi]

Did you try this locally with a fresh conda environment? I don't trust the CI tests on this one. As far as I can tell, the actual deployment of the website does not use a conda environment, so we need to test that this actually works within an environment.

no, I was hoping you would, since you already have the conda env that exposed the problem in the first place. Lemme know if you strapped for time, I can test it meself 🍺

[valeriupredoi]

alas, ideally, we should include a GHA that run exactly that, so we catch an issue early on - if you give me the command sequence, I can pop a workflow in here

[schlunma]

I did what is described here: https://github.com/ESMValGroup/ESMValTool_Tutorial/blob/main/CONTRIBUTING.md#previewing-your-changes-locally

cd ESMValTool_Tutorial
mamba env create -f environment.yml -n tut
mamba activate tut
make serve

With your changes, I get this now:

$ make serve
bundle install && bundle update && bundle exec jekyll serve
Bundle complete! 1 Gemfile dependency, 93 gems now installed.
Bundled gems are installed into `./.vendor/bundle`
[DEPRECATED] Pass --all to `bundle update` to update everything
Fetching gem metadata from https://rubygems.org/...........
Resolving dependencies...
Bundle updated!
/home/manuel/ESMValTool_Tutorial/.vendor/bundle/ruby/4.0.0/gems/jekyll-3.9.0/lib/jekyll.rb:28: warning: csv used to be loaded from the standard library, but is not part of the default gems since Ruby 3.4.0.
You can add csv to your Gemfile or gemspec to fix this error.
bundler: failed to load command: jekyll (/home/manuel/ESMValTool_Tutorial/.vendor/bundle/ruby/4.0.0/bin/jekyll)
/home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundled_gems.rb:60:in 'Kernel.require': cannot load such file -- csv (LoadError)
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundled_gems.rb:60:in 'block (2 levels) in Kernel#replace_require'
        from /home/manuel/ESMValTool_Tutorial/.vendor/bundle/ruby/4.0.0/gems/jekyll-3.9.0/lib/jekyll.rb:28:in '<top (required)>'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundled_gems.rb:60:in 'Kernel.require'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundled_gems.rb:60:in 'block (2 levels) in Kernel#replace_require'
        from /home/manuel/ESMValTool_Tutorial/.vendor/bundle/ruby/4.0.0/gems/jekyll-3.9.0/exe/jekyll:8:in '<top (required)>'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/rubygems.rb:304:in 'Kernel#load'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/rubygems.rb:304:in 'Gem.activate_and_load_bin_path'
        from /home/manuel/ESMValTool_Tutorial/.vendor/bundle/ruby/4.0.0/bin/jekyll:25:in '<top (required)>'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundler/cli/exec.rb:61:in 'Kernel.load'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundler/cli/exec.rb:61:in 'Bundler::CLI::Exec#kernel_load'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundler/cli/exec.rb:24:in 'Bundler::CLI::Exec#run'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundler/cli.rb:500:in 'Bundler::CLI#exec'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundler/vendor/thor/lib/thor/command.rb:28:in 'Bundler::Thor::Command#run'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundler/vendor/thor/lib/thor/invocation.rb:127:in 'Bundler::Thor::Invocation#invoke_command'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundler/vendor/thor/lib/thor.rb:538:in 'Bundler::Thor.dispatch'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundler/cli.rb:35:in 'Bundler::CLI.dispatch'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundler/vendor/thor/lib/thor/base.rb:584:in 'Bundler::Thor::Base::ClassMethods#start'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundler/cli.rb:29:in 'Bundler::CLI.start'
        from /home/manuel/micromamba/envs/tut/lib/ruby/gems/4.0.0/gems/bundler-4.0.6/exe/bundle:28:in 'block in <top (required)>'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/bundler/friendly_errors.rb:118:in 'Bundler.with_friendly_errors'
        from /home/manuel/micromamba/envs/tut/lib/ruby/gems/4.0.0/gems/bundler-4.0.6/exe/bundle:20:in '<top (required)>'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/rubygems.rb:304:in 'Kernel#load'
        from /home/manuel/micromamba/envs/tut/lib/ruby/4.0.0/rubygems.rb:304:in 'Gem.activate_and_load_bin_path'
        from /home/manuel/micromamba/envs/tut/bin/bundle:31:in '<main>'
make: *** [Makefile:49: serve] Error 1

[valeriupredoi]

OK thanks, Manu! I'll take it from here then - it's not as easy as I initially thought then

[LisaBock]

Thanks @valeriupredoi for working on this issue.

I also had to change the Gemfile and added:

gem 'jekyll', '~> 4.3'
gem 'csv'
gem 'bigdecimal'

Together with the change in the Makefile it worked for me.

[valeriupredoi]

gem 'jekyll', '~> 4.3'
gem 'csv'
gem 'bigdecimal'

thanks a lot @LisaBock - I had those deps added too (but not committed, I just committed them in b8a199e) but I was struggling with the compilation - your change in the Makefile is the fix to that. Pls approve when you have a minute, cheers 🍻

[valeriupredoi]

ah actually, I see the same issue with deps solving in the CI as I saw on Friday - let me see if I can solve that

[LisaBock]

Thanks @valeriupredoi

I tried it, but I still have an issue with this line in the Gemfile:

gem 'github-pages', group: :jekyll_plugins

Error message:

bundle install && bundle update --all && bundle exec jekyll serve
Fetching gem metadata from https://rubygems.org/.........
Resolving dependencies...
Could not find compatible versions

    Because github-pages >= 117, < 178 depends on jekyll-sass-converter = 1.5.0
      and github-pages >= 44, < 147 depends on liquid = 3.0.6,
      github-pages >= 44, < 178 requires jekyll-sass-converter = 1.5.0 or liquid = 3.0.6.
(1) So, because github-pages >= 178 depends on jekyll-sass-converter = 1.5.2
      and github-pages >= 28, < 44 depends on jekyll = 2.4.0,
      github-pages >= 28 requires jekyll-sass-converter = 1.5.0 OR = 1.5.2 or liquid = 3.0.6 or jekyll = 2.4.0.

    Because github-pages >= 9, < 14 depends on kramdown = 1.2.0
      and github-pages < 9 depends on kramdown = 1.0.2,
      github-pages < 14 requires kramdown = 1.0.2 OR = 1.2.0.
    And because github-pages >= 14, < 32 depends on kramdown = 1.3.1,
      github-pages < 32 requires kramdown = 1.0.2 OR = 1.2.0 OR = 1.3.1.
And because github-pages >= 28 requires jekyll-sass-converter = 1.5.0 OR = 1.5.2 or liquid = 3.0.6 or jekyll = 2.4.0
(1),
one of jekyll-sass-converter = 1.5.0 OR = 1.5.2 or liquid = 3.0.6 or jekyll = 2.4.0 or kramdown = 1.0.2 OR = 1.2.0
OR = 1.3.1 must be true.
    And because jekyll >= 4.3.0 depends on jekyll-sass-converter >= 2.0, < 4.0
      and jekyll >= 4.3.0 depends on kramdown >= 2.3.1, < 3.A,
      jekyll >= 4.3.0 requires liquid = 3.0.6.
    So, because jekyll >= 3.5.0 depends on liquid ~> 4.0
      and Gemfile depends on jekyll ~> 4.3,
      version solving has failed.
make: *** [Makefile:49: serve] Error 6

[valeriupredoi]

yes that's what the CI is tripping on to as well, we have a dependency conflict with liquid and downgrading it doesn't work, let me see what I can do about it

[valeriupredoi]

@LisaBock @schlunma the solution proved to be simpler than I thought - simply removing github-pages as a dep does the trick - the Tut site builds well locally, and CI passes too since CI uses a different route of installing and building with github-pages

[valeriupredoi]

proves out the github-pages gem is not deprecated, but it is treated as so:

GitHub now recommends using GitHub Actions for building and deploying Pages sites instead.
This shift is because Actions give you:
full control over dependencies
newer versions of Jekyll (the gem is tied to older, fixed versions)
fewer limitations on plugins

One learns something new every day 😁

[schlunma]

Does that mean we have to add a new action to deploy the website? Or can we still use the deprecated way even with this change here?

[valeriupredoi]

Does that mean we have to add a new action to deploy the website? Or can we still use the deprecated way even with this change here?

the current CI does that for you, Manu - correctly set up with gh-pages via Actions

[valeriupredoi]

thanks @LisaBock 🍺 @schlunma Manu, could you pls confirm this does the trick for you as well?

[schlunma]

But not via a workflow file, right? The existing ones don't seem to actually deploy the website: https://github.com/ESMValGroup/ESMValTool_Tutorial/tree/main/.github/workflows

[schlunma]

Works for me as well! Thanks V! 🚀

The only remaining "issue" is the following deprecation warning during the build:

Deprecation Warning [global-builtin]: Global built-in functions are deprecated and will be removed in Dart Sass 3.0.0.
Use color.scale instead.

More info and automated migrator: https://sass-lang.com/d/import

   ╷
82 │   $gradientcolor2: scale-color($color, $lightness: 10%);
   │                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   ╵
    /home/manuel/ESMValTool_Tutorial/assets/css/lesson.scss 82:20   bkSetup()
    /home/manuel/ESMValTool_Tutorial/assets/css/lesson.scss 112:11  root stylesheet

[valeriupredoi]

@schlunma thanks, Manu! Th deployment is done via this GHA https://github.com/ESMValGroup/ESMValTool_Tutorial/actions/runs/24727766445

I honestly got no clue about that deprecation - something in SASS, let's deal with it when it breaks the whole spiel 😁

[schlunma]

Ah, I didn't know you can have GitHub actions workflows without workflow files. I guess this is enabled via the settings?