зеркало из https://github.com/github/docs.git
First pass a documenting Pages on Actions GA
This commit is contained in:
Родитель
6353bc5672
Коммит
1aa82241d2
|
@ -49,17 +49,11 @@ shortTitle: Configure publishing source
|
|||
|
||||
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)."
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion build-pages-with-actions %}
|
||||
|
||||
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 %} workflow 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.
|
||||
|
||||
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)."
|
||||
|
||||
{% note %}
|
||||
|
||||
{% data reusables.pages.pages-builds-with-github-actions-public-beta %}
|
||||
|
||||
{% endnote %}
|
||||
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)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
|
|
@ -30,27 +30,16 @@ shortTitle: Jekyll build errors for Pages
|
|||
|
||||
{% endnote %}
|
||||
|
||||
If Jekyll does attempt to build your site and encounters an error, you will receive a build error message. There are two main types of Jekyll build error messages.
|
||||
- A "Page build warning" message means your build completed successfully, but you may need to make changes to prevent future problems.
|
||||
- A "Page build failed" message means your build failed to complete. If Jekyll is able to detect a reason for the failure, you'll see a descriptive error message.
|
||||
If Jekyll does attempt to build your site and encounters an error, you will receive a build error message.
|
||||
|
||||
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)."
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt %}
|
||||
## Viewing Jekyll build error messages with {% data variables.product.prodname_actions %}
|
||||
|
||||
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)."
|
||||
{% note %}
|
||||
|
||||
{% data reusables.pages.pages-builds-with-github-actions-public-beta %}
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
|
||||
## Viewing your repository's build failures on {% data variables.product.product_name %}
|
||||
|
||||
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.
|
||||
|
||||
## Viewing Jekyll build error messages locally
|
||||
|
||||
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)."
|
||||
|
@ -63,7 +52,7 @@ We recommend testing your site locally, which allows you to see build error mess
|
|||
|
||||
## Viewing Jekyll build errors by email
|
||||
|
||||
{% ifversion pages-custom-workflow %}If you are publishing from a branch, when{% else %}When{% endif %} 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 %}
|
||||
{% ifversion pages-custom-workflow %}If you are publishing from a branch, when{% else %}When{% endif %} 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. {% data reusables.pages.build-failure-email-server %}
|
||||
|
||||
{% ifversion pages-custom-workflow %}If you are publishing with a custom {% data variables.product.prodname_actions %} workflow, in order to receive emails about build errors in your pull request, you must configure your workflow to run on the `pull_request` trigger. When you do this, we recommend that you skip any deploy steps if the workflow was triggered by the `pull_request` event. This will allow you to see any build errors without deploying the changes from your pull request to your site. For more information, see "[Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows#pull_request)" and "[Expressions](/actions/learn-github-actions/expressions)."{% endif %}
|
||||
|
||||
|
|
|
@ -0,0 +1,5 @@
|
|||
# Issue 7584
|
||||
# Building Pages sites with Actions [GA]
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
|
@ -1,8 +1,4 @@
|
|||
{% ifversion fpt %}
|
||||
1. Unless your {% data variables.product.prodname_pages %} site is built from a private or internal repository and published from a branch, your site is built and deployed with a {% data variables.product.prodname_actions %} workflow. For more information about how to view the workflow status, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)."
|
||||
{% ifversion build-pages-with-actions %}
|
||||
1. Your {% data variables.product.prodname_pages %} site is built and deployed with a {% data variables.product.prodname_actions %} workflow. {% data variables.product.prodname_actions %} is free for public repositories. Usage charges apply for private and internal repositories that go beyond the amount of free minutes they are given each. For more information, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)" and "{% data variables.product.prodname_actions %} [Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)".
|
||||
|
||||
{% note %}
|
||||
|
||||
{% data reusables.pages.pages-builds-with-github-actions-public-beta %}
|
||||
|
||||
{% endnote %}{% endif %}
|
||||
{% endif %}
|
|
@ -1,5 +0,0 @@
|
|||
{% ifversion fpt %}
|
||||
|
||||
**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.
|
||||
|
||||
{% endif %}
|
Загрузка…
Ссылка в новой задаче