📖 Update comment in GH Pages deploy script

Fixes #1669
jupyter-book · Jan 14, 2025 · 37d5712 · 37d5712
1 parent 7f29af8
commit 37d5712
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/.changeset/serious-boats-film.md b/.changeset/serious-boats-film.md
@@ -0,0 +1,5 @@
+---
+"myst-cli": patch
+---
+
+Update comment in gh action
diff --git a/packages/myst-cli/src/init/gh-actions/index.ts b/packages/myst-cli/src/init/gh-actions/index.ts
@@ -17,6 +17,7 @@ function createGithubPagesAction({
   isGithubIO?: boolean;
 }) {
   return `# This file was created automatically with \`myst init --gh-pages\` 🪄 💚
+# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
 
 name: MyST GitHub Pages Deploy
 on: