Webhooks

Create a new repository Repositories contain a project's files and version history. Have a project elsewhere? Import a repository. Required fields are marked with an asterisk (*). 1 General Repository owner and name Owner *

GitHub Pages/Get started/Configure publishing sourceHomeGitHub PagesQuickstartGet startedWhat is GitHub Pages?Create a GitHub Pages siteGitHub Pages limitsUse custom workflowsConfigure publishing sourceDelete a GitHub Pages siteUnpublish Pages siteCreate custom 404 pageSecure site with HTTPSUse submodules with PagesTroubleshoot 404 errorsSet up site with JekyllGitHub Pages & JekyllCreate site with JekyllTest site locally with JekyllAdd content to Pages siteSet Markdown processorAdd theme to Pages siteJekyll build errors for PagesTroubleshoot Jekyll errorsConfigure a custom domainCustom domains in GitHub PagesManage a custom domainVerify a custom domainTroubleshoot a custom domainGitHub Pages/Get started/Configure publishing sourceConfiguring a publishing source for your GitHub Pages siteYou can configure your GitHub Pages site to publish when changes are pushed to a specific branch, or you can write a GitHub Actions workflow to publish your site.Who can use this feature?People with admin or maintainer permissions for a repository can configure a publishing source for a GitHub Pages site.GitHub Pages is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s plans. GitHub Pages now uses GitHub Actions to execute the Jekyll build. When using a branch as the source of your build, GitHub Actions must be enabled in your repository if you want to use the built-in Jekyll workflow. Alternatively, if GitHub 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 GitHub Actions, see Managing GitHub Actions settings for a repository.In this articleAbout publishing sourcesPublishing from a branchPublishing with a custom GitHub Actions workflowAbout publishing sources You can publish your site when changes are pushed to a specific branch, or you can write a GitHub Actions workflow to publish your site. If you do not need any control over the build process for your site, we recommend that you publish your site when changes are pushed to a specific branch. You can specify which branch and folder to use as your publishing source. The source branch can be any branch in your repository, and the source folder can either be the root of the repository (/) on the source branch or a /docs folder on the source branch. Whenever changes are pushed to the source branch, the changes in the source folder will be published to your GitHub Pages site. If you want to use a build process other than Jekyll or you do not want a dedicated branch to hold your compiled static files, we recommend that you write a GitHub Actions workflow to publish your site. GitHub provides workflow templates for common publishing scenarios to help you write your workflow. Warning GitHub Pages sites are publicly available on the internet, even if the repository for the site is private (if your plan or organization allows it). If you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see About repositories. Publishing from a branch Make sure the branch you want to use as your publishing source already exists in your repository. On GitHub, navigate to your site's repository. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings. In the "Code and automation" section of the sidebar, click Pages. Under "Build and deployment", under "Source", select Deploy from a branch. Under "Build and deployment", use the branch dropdown menu and select a publishing source. Optionally, use the folder dropdown menu to select a folder for your publishing source. Click Save. Troubleshooting publishing from a branch Note If your repository contains symbolic links, you will need to publish your site using a GitHub Actions workflow. For more information about GitHub Actions, see GitHub Actions documentation. Note If you are publishing from a branch and your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source. Commits pushed by a GitHub Actions workflow that uses the GITHUB_TOKEN do not trigger a GitHub Pages build. 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 GitHub Pages sites. Your GitHub Pages site will always be deployed with a GitHub Actions workflow run, even if you've configured your GitHub Pages site to be built using a different CI tool. Most e