Deploying seems to overwrite custom domain

Question

Deploying seems to overwrite custom domain

Opened this issue 7 years ago · 25 comments

I am deploying a GatsbyJS site to GitHub pages with this command:

gatsby build --prefix-paths && gh-pages -d public -b master

I need to push to the master branch because it's a user site (rather than a project site). This works but each time I do it, the repo's "Custom domain" setting is reset. This means after every deploy I need to go into the settings and re-enter the custom domain. No idea if this is a bug or if I'm just missing something obvious.

Answer 1 · 2017-11-15T19:35:28.000Z

also getting this bug...

Answer 2 · 2017-11-24T15:49:10.000Z

@unlikenesses @atav32

It seems you need to include a file named CNAME at the root of your file structure.
Your custom domain should be the first line in this file.

In my case, the CNAME file would have this content:

youfoundron.com

Credit goes to this comment.

Answer 3 · 2017-12-23T20:43:13.000Z

Just adapt this lines to your DEPLOYMENT script

var ghpages = require('gh-pages');
var fs = require('fs');

fs.writeFile('dist/CNAME', "your-custom-domain.com", function(err) {});
ghpages.publish('dist', function(err) {});

Answer 4 · 2019-02-13T17:10:15.000Z

I came across the same issue and just added a npm script for this before publishing.

"add-domain": "echo \"customdomain.com\" > build/CNAME",

Answer 5 · 2019-03-30T14:04:37.000Z

If you use gh-pages for React app deployment – just put CNAME file with your domain into public folder.

Answer 6 · 2020-01-30T17:09:43.000Z

For angular 8.
Create a CNAME file inside the src folder.
then Inside angular.json
"assets": [
"src/favicon.ico",
"src/assets",
"src/CNAME" // This is the change you need to make.
],

Answer 7 · 2020-02-07T21:55:31.000Z

It would be nice if this behavior was documented in the README.

Answer 8 · 2020-05-31T18:37:06.000Z

If you use gh-pages for React app deployment – just put CNAME file with your domain into public folder.

Thank you it helped

Answer 9 · 2020-10-09T23:19:51.000Z

If you are using Gatsby just create a CNAME file inside the static folder and put your domain inside it like example.com

Answer 10 · 2020-12-20T06:59:41.000Z

I'm using no react just plain html css js. How do I resolve this issue?

Answer 11 · 2020-12-23T18:32:58.000Z

As others have said, just put a CNAME file that contains only your domain in the directory that is being published. This will work independently of what tools you are using.

Answer 12 · 2021-02-07T12:36:21.000Z

I'm using no react just plain html css js. How do I resolve this issue?

@rjitsu just put a CNAME to your root folder

Answer 13 · 2022-04-12T08:21:31.000Z

I have a CNAME file in my root folder and it still resets the domain.. Any suggestions?

Answer 14 · 2022-04-12T18:47:38.000Z

@iamlasse

Is the CNAME file present at root after building for your github pages branch?

If not, which tool are you using to bundle your static assets?

Answer 15 · 2022-04-12T20:08:24.000Z

Please see your gh-pages branch and see if it has a CNAME file in it

Answer 16 · 2022-05-11T11:51:56.000Z

For Hugo, I moved the CNAME file to the "public" directory as that is where the static site resources and assets are built by the GitHub Action.

Answer 17 · 2022-05-11T12:23:46.000Z

@iamlasse

Is the CNAME file present at root after building for your github pages branch?

If not, which tool are you using to bundle your static assets?

Yes, the CNAME file is in the root in gh-pages branch with the domain as the only text inside.

Answer 18 · 2022-05-28T10:44:36.000Z

same problem here: CNAME file is in the build/ folder, but the custom domain keeps resetting...

Answer 19 · 2022-06-08T13:56:16.000Z

same problem here. CNAME available in the gh-pages branch root folder and the GitHub Pages custom domain keeps resetting on every deploy

Answer 20 · 2022-08-05T23:18:14.000Z

I was also having this same issue as @dimitarangelko. It turned out the issue was that there were slightly different formats of the link in the CNAME files and In the package.json "add-domain": script line

it was "add-domain": "echo "https://mypage.app\" > build/CNAME",
and it had https://mypage.app/ in the gh-pages branch CNAME file, but had just mypage.app in the master branch CNAME file. I switched them all to just mypage.app like so

public/CNAME (in master): mypage.app
CNAME file (in GH-Pages): mypage.app
and in package.json: "add-domain": "echo "mypage.app" > build/CNAME",

made sure that the correct domain was set up in github pages before doing this and pulled them in in the gh-pages branch. Saved it all and ran npm run deploy and it finally didn't replace it!

Answer 21 · 2022-11-14T14:05:43.000Z

CNAME file is in my main and gh-pages branches, and at the root of each. But this still happens. Any ideas?

I'm building a Vite React app, I use GitHub actions to build and push to gh-pages branch.

Answer 22 · 2023-01-18T19:46:27.000Z

For Hugo (as mentioned above) you can add the CNAME like so from the root of your directory:

$ mkdir -p public
$ echo 'www.<yourdomain>.com' > public/CNAME

Adding this because I wasn't sure exactly where the public directory should be, and I didn't know what a CNAME file contained.

Answer 23 · 2023-10-16T15:43:29.000Z

I have the same problem using Hugo.

I'm using the deploy from branch gh-pages
the CNAME is set in both branches main and gh-pages

I think this worked fine before the option deploy using github actions, and I never chose this option because I have my own actions to build and update the branch gh-pages. I think that the problem is something in the new way that github handles the deployment.

Answer 24 · 2023-10-19T20:17:22.000Z

I have the same problem using Hugo.

I'm using the deploy from branch gh-pages

the CNAME is set in both branches main and gh-pages

I think this worked fine before the option deploy using github actions, and I never chose this option because I have my own actions to build and update the branch gh-pages. I think that the problem is something in the new way that github handles the deployment.

I am using Sphinx, but I fixed this by adding CNAME to the directory from which Pages deploys the source.

E.g., if your build.yml is directing Pages to use the build/ subfolder of root for deployment, then add CNAME to build/ in the main branch.

Answer 25 · 2023-10-21T14:46:37.000Z

I have the same problem using Hugo.

I'm using the deploy from branch gh-pages

the CNAME is set in both branches main and gh-pages

I think this worked fine before the option deploy using github actions, and I never chose this option because I have my own actions to build and update the branch gh-pages. I think that the problem is something in the new way that github handles the deployment.

I am using Sphinx, but I fixed this by adding CNAME to the directory from which Pages deploys the source.

E.g., if your build.yml is directing Pages to use the build/ subfolder of root for deployment, then add CNAME to build/ in the main branch.

I do that.
https://github.com/fguisso/fguisso.github.io/blob/gh-pages/CNAME

I follow the file to show to you and noticing that every deploy removes de CNAME file, but this actions is not setting by me: https://github.com/fguisso/fguisso.github.io/commits/gh-pages/CNAME