Skip to content

Commit eca5b64

Browse files
jmarlena“jmarlena”OctomergeryoannchaudetSarah Edwards
authored
GitHub Pages workflow runs for every GitHub Pages site (#22797)
* Add section about GitHub Pages workflow run * Create a reusable step for checking workflow run * Add a public beta reusable note * Add new reusable for checking workflows for build errors * Add new reusable and new sections to this article * Add that space * Convert reusable to regular text * Add alternate CI caveat to reusable * Playing with spacing * Change versioning to fpt only * Fix formatting for reusable with note * Add troubleshooting detail * Apply suggestions from code review Co-authored-by: Yoann Chaudet <yoannchaudet@github.com> * Apply suggestions from code review * Reframe step without resuable * Remove resuable for now * Apply suggestions from code review Co-authored-by: Sarah Edwards <skedwards88@github.com> * Apply suggestions from code review * Revamp the reusables * Apply suggestions from code review Co-authored-by: Sarah Edwards <skedwards88@github.com> * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Tommy Byrd <tcbyrd@github.com> Co-authored-by: “jmarlena” <“jmarlena@github.com”> Co-authored-by: Octomerger Bot <63058869+Octomerger@users.noreply.github.com> Co-authored-by: Yoann Chaudet <yoannchaudet@github.com> Co-authored-by: Sarah Edwards <skedwards88@github.com> Co-authored-by: Tommy Byrd <tcbyrd@github.com>
1 parent 3f2283f commit eca5b64

7 files changed

Lines changed: 51 additions & 3 deletions

File tree

‎content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,17 @@ Before you configure a publishing source, make sure the branch you want to use a
3838
{% data reusables.pages.admin-must-push %}
3939

4040
If you choose the `docs` folder on any branch as your publishing source, then later remove the `/docs` folder from that branch in your repository, your site won't build and you'll get a page build error message for a missing `/docs` folder. For more information, see "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites#missing-docs-folder)."
41+
42+
{% ifversion fpt %}
43+
44+
Your {% data variables.product.prodname_pages %} site will always be deployed with a {% data variables.product.prodname_actions %} workflow run, even if you've configured your {% data variables.product.prodname_pages %} site to be built using a different CI tool. Most external CI workflows "deploy" to GitHub Pages by committing the build output to the `gh-pages` branch of the repository, and typically include a `.nojekyll` file. When this happens, the {% data variables.product.prodname_actions %} worfklow will detect the state that the branch does not need a build step, and will execute only the steps necessary to deploy the site to {% data variables.product.prodname_pages %} servers.
45+
46+
To find potential errors with either the build or deployment, you can check the workflow run for your {% data variables.product.prodname_pages %} site by reviewing your repository's workflow runs. For more information, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." For more information about how to re-run the workflow in case of an error, see "[Re-running workflows and jobs](/actions/managing-workflow-runs/re-running-workflows-and-jobs)."
47+
48+
{% note %}
49+
50+
{% data reusables.pages.pages-builds-with-github-actions-public-beta %}
51+
52+
{% endnote %}
53+
54+
{% endif %}

‎content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ shortTitle: Create a GitHub Pages site
5353
{% data reusables.pages.sidebar-pages %}{% ifversion fpt or ghec %}
5454
{% data reusables.pages.choose-visibility %}{% endif %}
5555
{% data reusables.pages.visit-site %}
56+
{% data reusables.pages.check-workflow-run %}
5657

5758
{% data reusables.pages.admin-must-push %}
5859

‎content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,34 @@ If Jekyll does attempt to build your site and encounters an error, you will rece
3636

3737
For more information about troubleshooting build errors, see "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites)."
3838

39-
## Viewing Jekyll build error messages
39+
{% ifversion fpt %}
40+
## Viewing Jekyll build error messages with {% data variables.product.prodname_actions %}
41+
42+
By default, your {% data variables.product.prodname_pages %} site is built and deployed with a {% data variables.product.prodname_actions %} workflow run unless you've configured your {% data variables.product.prodname_pages %} site to use a different CI tool. To find potential build errors, you can check the workflow run for your {% data variables.product.prodname_pages %} site by reviewing your repository's workflow runs. For more information, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." For more information about how to re-run the workflow in case of an error, see "[Re-running workflows and jobs](/actions/managing-workflow-runs/re-running-workflows-and-jobs)."
43+
{% note %}
44+
45+
{% data reusables.pages.pages-builds-with-github-actions-public-beta %}
46+
47+
{% endnote %}
48+
{% endif %}
49+
50+
## Viewing your repository's build failures on {% data variables.product.product_name %}
51+
52+
You can see build failures (but not build warnings) for your site on {% data variables.product.product_name %} in the **Settings** tab of your site's repository.
53+
54+
## Viewing Jekyll build error messages locally
4055

4156
We recommend testing your site locally, which allows you to see build error messages on the command line, and addressing any build failures before pushing changes to {% data variables.product.product_name %}. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)."
4257

58+
## Viewing Jekyll build error messages in your pull request
59+
4360
When you create a pull request to update your publishing source on {% data variables.product.product_name %}, you can see build error messages on the **Checks** tab of the pull request. For more information, see "[About status checks](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)."
4461

62+
## Viewing Jekyll build errors by email
63+
4564
When you push changes to your publishing source on {% data variables.product.product_name %}, {% data variables.product.prodname_pages %} will attempt to build your site. If the build fails, you'll receive an email at your primary email address. You'll also receive emails for build warnings. {% data reusables.pages.build-failure-email-server %}
4665

47-
You can see build failures (but not build warnings) for your site on {% data variables.product.product_name %} in the **Settings** tab of your site's repository.
66+
## Viewing Jekyll build error messages in your pull request with a third-party CI service
4867

4968
You can configure a third-party service, such as [Travis CI](https://travis-ci.org/), to display error messages after each commit.
5069

‎content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ $ git remote add origin https://<em>HOSTNAME</em>/<em>USER</em>/<em>REPOSITORY</
119119
{% ifversion fpt or ghec %}
120120
{% data reusables.pages.choose-visibility %}{% endif %}
121121
{% data reusables.pages.visit-site %}
122+
{% data reusables.pages.check-workflow-run %}
122123

123124
{% data reusables.pages.admin-must-push %}
124125

‎data/reusables/pages/check-workflow-run.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{% ifversion fpt %}
2+
1. If your {% data variables.product.prodname_pages %} site is built from a public repository, it is built and deployed with a {% data variables.product.prodname_actions %} workflow run unless you've configured your {% data variables.product.prodname_pages %} site to use a different CI tool. For more information about how to view the workflow status, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)."
3+
4+
{% note %}
5+
6+
{% data reusables.pages.pages-builds-with-github-actions-public-beta %}
7+
8+
{% endnote %}{% endif %}

‎data/reusables/pages/pages-builds-with-github-actions-public-beta.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{% ifversion fpt %}
2+
3+
**Note:** {% data variables.product.prodname_actions %} workflow runs for your {% data variables.product.prodname_pages %} sites are in public beta for public repositories and subject to change. {% data variables.product.prodname_actions %} workflow runs are free for public repositories.
4+
5+
{% endif %}

‎data/reusables/pages/twenty-minutes-to-publish.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
**Note:** It can take up to 20 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. If your don't see your changes reflected in your browser after an hour, see "[About Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/about-jekyll-build-errors-for-github-pages-sites)."
1+
**Note:** It can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. If your don't see your {% data variables.product.prodname_pages %} site changes reflected in your browser after an hour, see "[About Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/about-jekyll-build-errors-for-github-pages-sites)."

0 commit comments

Comments
 (0)