CODEWITHSUNDEEP
githubgithub-pages
Martin
Martin

Reputation: 40593

Unable to change source branch in GitHub Pages

I have created a simple web site for GitHub Pages. The source of the site is in the "master" branch and the generated web site (what I want to see published) is under the "gh-pages" branch.

Branches

I was expecting to be able to change the source of the site in the settings. However, the setting is grayed out? I cannot change it (see screenshot below). What am I doing wrong? How do I switch to the "gh-pages" branch?

enter image description here

Upvotes: 47

Views: 19468

Answers (4)

Nathaniel Hibbler
Nathaniel Hibbler

Reputation: 195

In GitHub Pages when the branch of the site setting is Non-Responsive/grayed out/disabled. You only have to toggle the Source drop down to change & enable the branch:

  1. enter image description here
  2. Change dropdown to "GitHub Actions" enter image description here
  3. Change dropdown back to "Deploy from a branch" enter image description here
  4. Finally you will see it auto select main branch. It is odd but it works. enter image description here
  5. If you want to kick off a build then just toggle the branch dropdown to None and back to Main. enter image description here enter image description here

Upvotes: 0

Anton Sizikov
Anton Sizikov

Reputation: 9240

Personal or organization sites are built from master. gh-pages branch is used to build sites for projects.

As far as I can see, you're using https://user-name.github.io/ url, this is a personal one, so that's why master branch is the default one.

See the documentation page

If your site is a User or Organization Page that has a repository named <username>.github.io or <orgname>.github.io, you cannot publish your site's source files from different locations. User and Organization Pages that have this type of repository name are only published from the master branch.

So the answer is No, you can not change it. You'll have to adjust your workflow and keep development in another branch (let's call it development) and merge to master when you're ready to publish.

UPD: It's 2020 out there, so as of July 31st GitHub Pages allow you to configure any branch to act as an old master

GitHub pages build branch selector

Upvotes: 53

Rob van der Leek
Rob van der Leek

Reputation: 1818

FWIW, this is the setup I used for publishing a personal page (i.e. https://user-name.github.io) using Next.js and gh-pages:

  1. Create a different default branch in your repo to work in (e.g. develop)
  2. Build a static export of your site: next build && next export
  3. Put a .nojekyll marker file in the export directory: touch out/.nojekyll
  4. Upload the static export to the master branch: gh-pages -t -b master -d out

You can bundle these commands in package.json to get a convenient yarn deploy command:

scripts: {
  ...
  "build": "next build",
  "export": "yarn run build && next export",
  "deploy": "yarn export && touch out/.nojekyll && gh-pages -t -b master -d out"
  ...

Upvotes: 4

Abdullah Mohammad Motiullah
Abdullah Mohammad Motiullah

Reputation: 12572

Ok so if you are using angular-cli-ghpages it will by default create a new branch gh-pages and publish to it.

Now as a starter, like me, if you are using https://user-name.github.io/ and you want your app to be published from the master branch of your user-name.github.io you can follow the below steps.

  1. Make a production ready build using 

    ng build --prod --base-href "/user-name.github.io/"

  2. Deploy to the master using angular-cli-ghpages using

    angular-cli-ghpages --branch=master

Hope this helps.

Upvotes: 0

Related Questions