3.8 KiB
title, intro, redirect_from, product, permissions, versions, topics, shortTitle
| title | intro | redirect_from | product | permissions | versions | topics | shortTitle | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Configuring a publishing source for your GitHub Pages site | If you use the default publishing source for your {% data variables.product.prodname_pages %} site, your site will publish automatically. You can also choose to publish your site from a different branch or folder. |
|
{% data reusables.gated-features.pages %} | People with admin or maintainer permissions for a repository can configure a publishing source for a {% data variables.product.prodname_pages %} site. |
|
|
Configure publishing source |
For more information about publishing sources, see "About {% data variables.product.prodname_pages %}."
Choosing a publishing source
Before you configure a publishing source, make sure the branch you want to use as your publishing source already exists in your repository.
{% data reusables.pages.navigate-site-repo %}
{% data reusables.repositories.sidebar-settings %}
{% data reusables.pages.sidebar-pages %}
3. Under "{% data variables.product.prodname_pages %}", use the None or Branch drop-down menu and select a publishing source.
4. Optionally, use the drop-down menu to select a folder for your publishing source.
5. Click Save.
Troubleshooting publishing problems with your {% data variables.product.prodname_pages %} site
{% data reusables.pages.admin-must-push %}
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."
{% ifversion fpt %}
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.
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." For more information about how to re-run the workflow in case of an error, see "Re-running workflows and jobs."
{% note %}
{% data reusables.pages.pages-builds-with-github-actions-public-beta %}
{% endnote %}
{% endif %}