docs icon indicating copy to clipboard operation
docs copied to clipboard

Configuring custom domain for github pages site that was built remotely

Open brianwaithaka opened this issue 2 years ago • 2 comments

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain

What part(s) of the article would you like to see updated?

Details

  • When deploying to github-pages environment using a GitHub Actions workflow, current docs do not describe a way to authenticate the subdomain
  • Current docs method (point 8) creates a CNAME file, it only covers use case of deploying GitHub Pages from a branch

Supported use case

  • Using a static site generator and GitHub Actions workflow to build and remotely publish to github-pages environment for GitHub Pages

Outcome

  • After testing, I got it to work by authenticating just the subdomain in user settings as stated here https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages#verifying-a-domain-for-your-user-site
  • To build and deploy files with GitHub Actions workflow, create cname record with dns provider, then authenticate subdomain in user settings

Additional information

No response

brianwaithaka avatar Jun 15 '23 14:06 brianwaithaka

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Jun 15 '23 14:06 welcome[bot]

@brianwaithaka Thank you for opening an issue and linking it to your PR! ✨

cmwilson21 avatar Jun 16 '23 19:06 cmwilson21

A stale label has been added to this issue because it has been open for 60 days with no activity. To keep this issue open, add a comment within 3 days.

github-actions[bot] avatar Aug 16 '23 16:08 github-actions[bot]

No on

benb24-cloud avatar Oct 13 '23 00:10 benb24-cloud

#reyelcidbugarinabetria

Kingodbug avatar Nov 12 '23 15:11 Kingodbug

Closing this issue as the PR went stale. If you'd like to continue to work on it, please ping me in the PR and I'll reopen both! 👍

cmwilson21 avatar Nov 13 '23 14:11 cmwilson21