1
0
mirror of synced 2026-01-06 15:01:04 -05:00

Merge pull request #29228 from github/pages-actions-ga-doc

First pass a documenting Pages on Actions GA
This commit is contained in:
Jenni Christensen
2022-08-09 15:21:17 -07:00
committed by GitHub
7 changed files with 25 additions and 28 deletions

View File

@@ -27,7 +27,7 @@ You can configure environments with protection rules and secrets. When a workflo
**Note:** You can only configure environments for public repositories. If you convert a repository from public to private, any configured protection rules or environment secrets will be ignored, and you will not be able to configure any environments. If you convert your repository back to public, you will have access to any previously configured protection rules and environment secrets.
Organizations that use {% data variables.product.prodname_ghe_cloud %} can configure environments for private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment). {% data reusables.enterprise.link-to-ghec-trial %}
Organizations with {% data variables.product.prodname_team %} and users with {% data variables.product.prodname_pro %} can configure environments for private repositories. For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/get-started/learning-about-github/githubs-products)."
{% endnote %}
{% endif %}
@@ -72,7 +72,7 @@ Secrets stored in an environment are only available to workflow jobs that refere
{% ifversion fpt or ghec %}
{% note %}
**Note:** To create an environment in a private repository, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %}
**Note:** Creation of an environment in a private repository is available to organizations with {% data variables.product.prodname_team %} and users with {% data variables.product.prodname_pro %}.
{% endnote %}
{% endif %}

View File

@@ -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 %}

View File

@@ -30,26 +30,27 @@ shortTitle: Jekyll build errors for Pages
{% endnote %}
{% ifversion build-pages-with-actions %}
If Jekyll does attempt to build your site and encounters an error, you will receive a build error message.
{% else %}
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.
{% endif %}
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 build-pages-with-actions %}
## 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 %}
{% ifversion build-pages-with-actions %}{% else %}
## 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.
{% endif %}
## Viewing Jekyll build error messages locally
@@ -63,7 +64,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 %}

View File

@@ -0,0 +1,5 @@
# Issue 7584
# Building Pages sites with Actions [GA]
versions:
fpt: '*'
ghec: '*'

View File

@@ -1 +1 @@
Environments, environment protection rules, and environment secrets are available in **public** repositories for all products. For access to environments in **private** repositories, you must use {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info %}
Environments, environment protection rules, and environment secrets are available in **public** repositories for all products. For access to environments in **private** or **internal** repositories, you must use {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info %}

View File

@@ -1,8 +1,10 @@
{% 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. For more information, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)".
{% note %}
{% note %}
{% data reusables.pages.pages-builds-with-github-actions-public-beta %}
**Note:** {% data variables.product.prodname_actions %} is free for public repositories. Usage charges apply for private and internal repositories that go beyond the monthly allotment of free minutes. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration)".
{% endnote %}{% endif %}
{% endnote %}
{% endif %}

View File

@@ -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 %}