From c4eb8ff21bc2bd2d97cc70cb2285b3980085de73 Mon Sep 17 00:00:00 2001 From: Sharra-writes Date: Fri, 1 Aug 2025 11:26:43 -0700 Subject: [PATCH] Reusable clarifying Actions is fully supported while Jekyll is not (#39148) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> --- .../about-github-pages-and-jekyll.md | 2 ++ .../about-jekyll-build-errors-for-github-pages-sites.md | 2 ++ .../adding-a-theme-to-your-github-pages-site-using-jekyll.md | 2 ++ .../adding-content-to-your-github-pages-site-using-jekyll.md | 2 ++ .../creating-a-github-pages-site-with-jekyll.md | 2 ++ ...arkdown-processor-for-your-github-pages-site-using-jekyll.md | 2 ++ .../testing-your-github-pages-site-locally-with-jekyll.md | 2 ++ data/reusables/gated-features/pages.md | 2 -- data/reusables/pages/actions-is-preferred.md | 1 + 9 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 data/reusables/pages/actions-is-preferred.md diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index ce0a0dc9cb..dc4ce9d214 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -28,6 +28,8 @@ topics: shortTitle: GitHub Pages & Jekyll --- +{% data reusables.pages.actions-is-preferred %} + ## About Jekyll Jekyll is a static site generator with built-in support for {% data variables.product.prodname_pages %} and a simplified build process. Jekyll takes Markdown and HTML files and creates a complete static website based on your choice of layouts. Jekyll supports Markdown and Liquid, a templating language that loads dynamic content on your site. For more information, see [Jekyll](https://jekyllrb.com/). diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index a5f906b54c..2c985e9c98 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -16,6 +16,8 @@ topics: shortTitle: Jekyll build errors for Pages --- +{% data reusables.pages.actions-is-preferred %} + ## About Jekyll build errors If you are publishing from a branch, sometimes {% data variables.product.prodname_pages %} will not attempt to build your site after you push changes to your site's publishing source.{% ifversion fpt or ghec %} diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md index 734b229c3f..3dc72423a5 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md @@ -17,6 +17,8 @@ topics: shortTitle: Add theme to Pages site --- +{% data reusables.pages.actions-is-preferred %} + People with write permissions for a repository can add a theme to a {% data variables.product.prodname_pages %} site using Jekyll. {% data reusables.pages.test-locally %} diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md index bcde47780d..c3923e7a88 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md @@ -14,6 +14,8 @@ topics: shortTitle: Add content to Pages site --- +{% data reusables.pages.actions-is-preferred %} + People with write permissions for a repository can add content to a {% data variables.product.prodname_pages %} site using Jekyll. ## About content in Jekyll sites diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md index 7ec6ce7893..36e2f7f29c 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md @@ -17,6 +17,8 @@ shortTitle: Create site with Jekyll +{% data reusables.pages.actions-is-preferred %} + ## Prerequisites Before you can use Jekyll to create a {% data variables.product.prodname_pages %} site, you must install Jekyll and Git. For more information, see [Installation](https://jekyllrb.com/docs/installation/) in the Jekyll documentation and [AUTOTITLE](/get-started/git-basics/set-up-git). diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md index 3fdc3333b7..526231ecd0 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md @@ -16,6 +16,8 @@ topics: shortTitle: Set Markdown processor --- +{% data reusables.pages.actions-is-preferred %} + People with write permissions for a repository can set the Markdown processor for a {% data variables.product.prodname_pages %} site. {% data variables.product.prodname_pages %} supports two Markdown processors: [kramdown](http://kramdown.gettalong.org/) and {% data variables.product.github %}'s own Markdown processor, which is used to render [{% data variables.product.prodname_dotcom %} Flavored Markdown (GFM)](https://github.github.com/gfm/) throughout {% data variables.product.github %}. For more information, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github). diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md index 3b7c5c59e7..caa1b798d7 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md @@ -64,6 +64,8 @@ Before you can use Jekyll to test a site, you must: ## Updating the {% data variables.product.prodname_pages %} gem +{% data reusables.pages.actions-is-preferred %} + Jekyll is an active open source project that is updated frequently. If the `github-pages` gem on your computer is out of date with the `github-pages` gem on the {% data variables.product.prodname_pages %} server, your site may look different when built locally than when published on {% data variables.product.github %}. To avoid this, regularly update the `github-pages` gem on your computer. {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/data/reusables/gated-features/pages.md b/data/reusables/gated-features/pages.md index 7128d564ba..ee1a3a1c2c 100644 --- a/data/reusables/gated-features/pages.md +++ b/data/reusables/gated-features/pages.md @@ -1,3 +1 @@ {% data variables.product.prodname_pages %} is available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% ifversion fpt or ghec %}{% data reusables.gated-features.more-info %}{% endif %} - -{% ifversion fpt or ghec %}{% data variables.product.prodname_pages %} now uses {% data variables.product.prodname_actions %} to execute the Jekyll build. When using a branch as the source of your build, {% data variables.product.prodname_actions %} must be enabled in your repository if you want to use the built-in Jekyll workflow. Alternatively, if {% data variables.product.prodname_actions %} is unavailable or disabled, adding a `.nojekyll` file to the root of your source branch will bypass the Jekyll build process and deploy the content directly. For more information on enabling {% data variables.product.prodname_actions %}, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository).{% endif %} diff --git a/data/reusables/pages/actions-is-preferred.md b/data/reusables/pages/actions-is-preferred.md new file mode 100644 index 0000000000..be53d8624d --- /dev/null +++ b/data/reusables/pages/actions-is-preferred.md @@ -0,0 +1 @@ +> [!NOTE] While this `github-pages` gem remains supported for some workflows, {% data variables.product.prodname_actions %} is now the recommended approach for deploying and automating {% data variables.product.prodname_pages %} sites.