From 037d633649224449439546198692f9ebe56cd849 Mon Sep 17 00:00:00 2001 From: rick-masters Date: Wed, 2 Feb 2022 12:09:39 -0800 Subject: [PATCH] Clarify GitHub Pages Branches --- content/en/hosting-and-deployment/hosting-on-github.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/content/en/hosting-and-deployment/hosting-on-github.md b/content/en/hosting-and-deployment/hosting-on-github.md index 675a696d3..ae30ce44a 100644 --- a/content/en/hosting-and-deployment/hosting-on-github.md +++ b/content/en/hosting-and-deployment/hosting-on-github.md @@ -34,14 +34,16 @@ There are two types of GitHub Pages: Please refer to the [GitHub Pages documentation][ghorgs] to decide which type of site you would like to create as it will determine which of the below methods to use. +## Branches for GitHub Actions + +The GitHub Actions used in these instructions pull source content from the `main` branch and then commit the generated content to the `gh-pages` branch. This applies regardless of what type of GitHub Pages you are using. This is a clean setup as your Hugo files are stored in one branch and your generated files are published into a separate branch. + ## GitHub User or Organization Pages As mentioned in the [GitHub Pages documentation][ghorgs], you can host a user/organization page in addition to project pages. Here are the key differences in GitHub Pages websites for Users and Organizations: -1. You must use a `.github.io` to host your **generated** content -2. Content from the `main` branch will be used to publish your GitHub Pages site - -This is a much simpler setup as your Hugo files and generated content are published into two different repositories. +1. You must create a repository named `.github.io` or `.github.io` to host your pages +2. By default, content from the `main` branch is used to publish GitHub Pages - rather than the `gh-pages` branch which is the default for project sites. However, the GitHub Actions in these instructions publish to the `gh-pages` branch. Therefore, if you are publishing Github pages for a user or organization, you will need to change the publishing branch to `gh-pages`. See the instructions later in this document. ## Build Hugo With GitHub Action