Contradictory information regarding CNAME and GitHub Pages and Actions

[climbTheStairs]

Code of Conduct

• I have read and agree to the GitHub Docs project's 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/troubleshooting-custom-domains-and-github-pages#cname-errors
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-an-apex-domain

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

In the first article:

If you are publishing from a custom GitHub Actions workflow, any CNAME file is ignored and is not required.

In the second one:

If you are publishing your site with a custom GitHub Actions workflow, no CNAME file is created, so you need to create one manually (containing only a line of text with your custom domain).

If I am publishing GitHub Pages with a custom GitHub Actions workflow, it is unclear whether I need to create a CNAME or not.

Additional information

No response

[welcome]

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.

[subatoi]

@climbTheStairs Thanks for raising an issue—this is really better suited for GitHub Support but in this case, I think our docs could be clearer here, so apologies for the confusion it's caused. Can I just establish: are you trying to publish from a specific branch that's not the default branch?

[climbTheStairs]

Is it even possible to publish from a specific branch if I'm publishing from a custom GitHub Actions workflow?

[subatoi]

I haven't attempted that, but I was trying to establish what you were trying to do; I'll assume it wasn't that. I'll investigate the original question internally to try to get a definitive answer. Thanks!

[subatoi]

@climbTheStairs Apologies for the confusion here—the first article is correct, and the second one needs to be updated. Would you like to open a PR to correct the wording in 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-an-apex-domain?

We need to remove so you need to create one manually (containing only a line of text with your custom domain) and mention that the CNAME is not only not created, but not required.