Skip to content

Add GitHub Pages helpful notes#9235

Merged
jekyllbot merged 2 commits intojekyll:masterfrom
fulldecent:patch-1
Oct 22, 2023
Merged

Add GitHub Pages helpful notes#9235
jekyllbot merged 2 commits intojekyll:masterfrom
fulldecent:patch-1

Conversation

@fulldecent
Copy link
Copy Markdown
Contributor

This is a 🔦 documentation change.

Summary

Adds a helpful setup note for people publishing with GitHub Pages.

Context

GitHub Pages will build your project using the github-pages gem and without any regard for your repository's Gemfile.lock file. This PR adds such a note to documentation and advises how you might work with that.

This restricts your Ruby environment to only use gems set in your `Gemfile`.

Note: if publishing your site with GitHub Pages, you can match production
version of Jekyll by using the `github-pages` gem instead of `github-pages`
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

by using the github-pages gem instead of github-pages
in your Gemfile

I... don't understand what this is saying?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, fixed at 2621159

Copy link
Copy Markdown
Member

@mattr- mattr- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. Would you be able to rebase this on top of current master to see if we get clean CI builds? Thank you! 🙇‍♂️

@fulldecent
Copy link
Copy Markdown
Contributor Author

fulldecent commented Oct 21, 2023

@mattr- rebased.

The build is not reproducible.

I compared the build CI logs on Ruby 3.2 for the last successful run to same for this PR.

Here's the hint:

-Bundle complete! 48 Gemfile dependencies, 130 gems now installed.
+Bundle complete! 48 Gemfile dependencies, 134 gems now installed.

And the specific problems:

-Fetching activesupport 7.0.8
-Installing activesupport 7.0.8
+Using activesupport 7.1.1

+Using bigdecimal 3.1.4

+Using connection_pool 2.4.1

+Using drb 2.1.1

-Fetching mime-types-data 3.2023.0808
-Installing mime-types-data 3.2023.0808
+Using mime-types-data 3.2023.1003

+Using mutex_m 0.1.2

-Fetching rubocop-minitest 0.32.2
-Installing rubocop-minitest 0.32.2
+Fetching rubocop-minitest 0.33.0
+Installing rubocop-minitest 0.33.0

-Fetching sass-embedded 1.68.0 (x86_64-linux-gnu)
-Installing sass-embedded 1.68.0 (x86_64-linux-gnu)
+Fetching sass-embedded 1.69.4 (x86_64-linux-gnu)
+Installing sass-embedded 1.69.4 (x86_64-linux-gnu)

-Fetching thor 1.2.2
-Installing thor 1.2.2
+Fetching thor 1.3.0
+Installing thor 1.3.0

A root cause is that our dependencies at underspecified at https://github.com/jekyll/jekyll/blob/8e4ccfc4ff3020633b378ca81e17b8e7adee1a39/Gemfile

Another root cause is that apparently some upstream dependency broke the API contract in a minor release.

Hypothesis: if any other change is committed in this repo today, by PR or by direct commit, it will fail with the same errors.


Here is a PR that fixes this going forward, but does not fix the current problem.

#9468

Copy link
Copy Markdown
Member

@mattr- mattr- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! ❤️

@jekyllbot: merge +docs

@jekyllbot jekyllbot merged commit c52bbde into jekyll:master Oct 22, 2023
jekyllbot added a commit that referenced this pull request Oct 22, 2023
github-actions bot pushed a commit that referenced this pull request Oct 22, 2023
William Entriken: Add GitHub Pages helpful notes (#9235)

Merge pull request 9235
@fulldecent fulldecent deleted the patch-1 branch October 23, 2023 23:05
@jekyll jekyll locked and limited conversation to collaborators Oct 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants