ci: big ⚠️ to ensure the CNAME file always exist

weihanglo · Oct 19, 2023 · 22deaf8 · 22deaf8
1 parent 5fab767
commit 22deaf8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.github/workflows/contrib.yml b/.github/workflows/contrib.yml
@@ -43,7 +43,11 @@ jobs:
         # Generate HTML for link redirections.
         python3 "$GENERATE_PY"
         git add *.html
+        # WARN: The CNAME file is for GitHub to redirect requests to the custom domain.
+        # Missing this may entail security issue and domain takeover.
+        # See <https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#securing-your-custom-domain>
         git add CNAME
 
+
         git commit -m "Deploy $GITHUB_SHA to gh-pages"
         git push origin +gh-pages
diff --git a/ci/generate.py b/ci/generate.py
@@ -39,6 +39,9 @@ def main():
                 mapped = "https://doc.rust-lang.org/cargo/reference/{}".format(name)
             f.write(TEMPLATE.format(name=name, mapped=mapped))
 
+    # WARN: The CNAME file is for GitHub to redirect requests to the custom domain.
+    # Missing that may entail security issue and domain takeover.
+    # See <https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#securing-your-custom-domain>
     with open('CNAME', 'w') as f:
         f.write('doc.crates.io')