Skip to content

Improve docs around using GitHub Actions to build and deploy Jekyll sites#9682

Merged
jekyllbot merged 10 commits intojekyll:masterfrom
nisbet-hubbard:patch-1
Sep 22, 2024
Merged

Improve docs around using GitHub Actions to build and deploy Jekyll sites#9682
jekyllbot merged 10 commits intojekyll:masterfrom
nisbet-hubbard:patch-1

Conversation

@nisbet-hubbard
Copy link
Copy Markdown
Contributor

@nisbet-hubbard nisbet-hubbard commented Sep 16, 2024

This is a 🔦 documentation change.

Summary

Migration from standard flow can be fraught with surprises if one keeps using a GitHub-hosted theme. This PR smooths the way by pointing out the necessary configurations.

@nisbet-hubbard nisbet-hubbard changed the title Add caveat to github-actions.md for migration from standard flow Improve docs around migration from standard flow to jekyll.yml Sep 16, 2024
ashmaroli
ashmaroli reviewed Sep 16, 2024
View reviewed changes
@nisbet-hubbard @ashmaroli
Break long lines in installation.md
91cae27 
Co-authored-by: Ashwin Maroli <ashmaroli@users.noreply.github.com>
@ashmaroli
Copy link
Copy Markdown
Member

ashmaroli commented Sep 18, 2024

Hello @nisbet-hubbard,
I have multiple misgivings with the proposed additions:

  • What is this standard flow? This phrase has not been described / defined beforehand.
  • Why are you recommending to add all gems at pages.github.com/versions/ to Gemfile + config_file? Let the user install only those gems they actually need.
  • The note addition at /docs/plugin/installation/ is inconclusive. The workaround is to use GitHub Actions not using jekyll.yml. jekyll.yml is just an example workflow.

@nisbet-hubbard
Copy link
Copy Markdown
Contributor Author

nisbet-hubbard commented Sep 21, 2024 •
edited
Loading

Thanks for the queries! I had misgivings about their wording too:

jekyll/docs/_docs/continuous-integration/github-actions.md

Lines 5 to 7 in ca57a45

When building a Jekyll site with GitHub Pages, the standard flow is restricted for security reasons
and to make it simpler to get a site setup. For more control over the build and still host the site
with GitHub Pages you can use GitHub Actions.

I have now incorporated your suggestions to reflect the fact that the default GitHub Pages Jekyll workflow is also an Actions workflow, and the current choice is between two Actions workflows: GitHub Pages Jekyll or Jekyll.

@ashmaroli ashmaroli changed the title Improve docs around migration from standard flow to jekyll.yml Improve docs around using GitHub Actions to build and deploy Jekyll sites Sep 22, 2024
@ashmaroli
Copy link
Copy Markdown
Member

ashmaroli commented Sep 22, 2024

Thanks @nisbet-hubbard
@jekyllbot: merge +doc

@jekyllbot jekyllbot merged commit 860c5d6 into jekyll:master Sep 22, 2024
jekyllbot added a commit that referenced this pull request Sep 22, 2024
@jekyllbot
Update history to reflect merge of #9682 [ci skip]
e223b9e
github-actions bot pushed a commit that referenced this pull request Sep 22, 2024
@jekyllbot
Deploy docs from 860c5d6
a85a624 
nisbet-hubbard: Improve docs around using GitHub Actions to build and deploy Jekyll sites (#9682)

Merge pull request 9682
@jekyll jekyll locked and limited conversation to collaborators Sep 22, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@ashmaroli ashmaroli ashmaroli approved these changes

Assignees

No one assigned

Labels

documentation frozen-due-to-age

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@nisbet-hubbard @ashmaroli @jekyllbot