@@ -55,20 +55,19 @@ jobs:
5555 name : site
5656 path : site
5757
58- # GitHub Pages serves the custom domain from a CNAME file at the site
59- # root. Written here rather than committed under docs/ so the docs
60- # directory stays pure content and the domain lives with the
61- # deployment, where a change to it belongs.
62- - name : Custom domain
63- run : echo "docs.spinloop.ai" > site/CNAME
64-
65- # Pages must be enabled on the repository once (Settings -> Pages ->
66- # Source: GitHub Actions), or via the API:
67- # curl -X POST -H "Authorization: Bearer <token>" \
68- # https://api.github.com/repos/<owner>/<repo>/pages \
69- # -d '{"build_type":"workflow"}'
70- # The workflow token cannot create the site itself, so this is a
71- # one-time admin step before the first deploy.
58+ # The custom domain is not part of the artifact: for a site published
59+ # by a workflow, GitHub ignores any CNAME file and the domain lives in
60+ # the repository's Pages setting. Both of these are one-time admin
61+ # steps, because the workflow token cannot make them:
62+ # 1. enable Pages (build type: workflow)
63+ # curl -X POST -H "Authorization: Bearer <token>" \
64+ # https://api.github.com/repos/<owner>/<repo>/pages \
65+ # -d '{"build_type":"workflow"}'
66+ # 2. once the DNS CNAME points at the site's base domain
67+ # (docs.spinloop.ai -> spinloop-ai.github.io), register it
68+ # curl -X PUT -H "Authorization: Bearer <token>" \
69+ # https://api.github.com/repos/<owner>/<repo>/pages \
70+ # -d '{"cname":"docs.spinloop.ai","source":{"branch":"main","path":"/"}}'
7271 - uses : actions/configure-pages@v6
7372 - uses : actions/upload-pages-artifact@v5
7473 with :
0 commit comments