update

Author: monapdx

src/App.jsx

@@ -350,7 +350,8 @@ export default function App() {
       const publishedDraftId = draftId
       const s = slug.trim() || slugify(title) || 'post'
       const path = postRepoPath(s)
-      const { indexHomeBanner, indexErrorToast, successMessage } = await publishPostAndIndex({
+      const { indexHomeBanner, indexErrorToast, successMessage, workflowWarning } =
+        await publishPostAndIndex({
         form,
         path,
         slug: s,
@@ -362,6 +363,7 @@ export default function App() {
       })
       setIndexHomeBanner(indexHomeBanner)
       if (indexErrorToast) pushToast(indexErrorToast)
+      if (workflowWarning) pushToast(workflowWarning)
 
       setGithubSettings({ ...form })
       if (!persistGithubSettings({ ...form })) {

src/lib/__tests__/repoSiteBootstrap.test.js

@@ -1,10 +1,30 @@
 import { describe, expect, it } from 'vitest'
+import { PAGES_WORKFLOW } from '../blogPaths'
+import {
+  buildPagesWorkflowYaml,
+  formatBootstrapStatusMessage,
+} from '../repoSiteBootstrap'
 import { READ_ONLY_TEMPLATES } from '../readOnlyTemplates'
 
-describe('pages workflow template', () => {
-  it('deploys the blog folder', () => {
-    const yml = READ_ONLY_TEMPLATES.githubPagesWorkflowYaml.replace(/\{\{BLOG_DIR\}\}/g, 'blog')
-    expect(yml).toContain('path: blog')
+describe('buildPagesWorkflowYaml', () => {
+  it('deploys ./blog and targets the repo-root workflow path', () => {
+    const yml = buildPagesWorkflowYaml('main')
+    expect(yml).toContain('path: ./blog')
+    expect(yml).toContain('branches: [main]')
     expect(yml).toContain('configure-pages@v5')
+    expect(yml).toContain('name: Upload blog artifact')
+    expect(READ_ONLY_TEMPLATES.githubPagesWorkflowYaml).toContain('./blog')
+    expect(PAGES_WORKFLOW).toBe('.github/workflows/deploy-blog-pages.yml')
+  })
+})
+
+describe('formatBootstrapStatusMessage', () => {
+  it('lists created and found paths', () => {
+    const msg = formatBootstrapStatusMessage([
+      { path: 'blog/index.html', status: 'created' },
+      { path: PAGES_WORKFLOW, status: 'failed' },
+    ])
+    expect(msg).toContain('blog/index.html created')
+    expect(msg).toContain(`${PAGES_WORKFLOW} missing`)
   })
 })

src/lib/publishPipeline.js

@@ -74,6 +74,7 @@ export async function publishPostAndIndex({
 
   let indexHomeBanner = { show: false, text: '' }
   let indexErrorToast = null
+  let workflowWarning = site.workflowWarning
 
   try {
     const indexResult = tryUpdateIndexWithCard({
@@ -102,10 +103,16 @@ export async function publishPostAndIndex({
     indexErrorToast = `${friendly} Post was saved; blog/index.html was not updated.`
   }
 
-  let successMessage = `Published ${path}`
-  if (site.created.length) successMessage += ` · Bootstrapped: ${site.created.join(', ')}`
-  if (site.warnings[0]) successMessage += ` · ${site.warnings[0]}`
-  if (site.pagesSetupHint) successMessage += ` ${site.pagesSetupHint}`
+  let successMessage = `Published ${path} · ${site.bootstrapStatusMessage}`
+  if (site.pagesSetupHint && site.workflowOk) {
+    successMessage += ` · ${site.pagesSetupHint}`
+  }
 
-  return { successMessage, indexHomeBanner, indexErrorToast }
+  return {
+    successMessage,
+    workflowWarning,
+    workflowOk: site.workflowOk,
+    indexHomeBanner,
+    indexErrorToast,
+  }
 }

src/lib/repoSiteBootstrap.js

@@ -2,13 +2,11 @@ import {
   BLOG_INDEX,
   BLOG_NOJEKYLL,
   BLOG_POSTS_GITKEEP,
-  BLOG_ROOT,
   BLOG_STYLE,
   PAGES_WORKFLOW,
 } from './blogPaths'
 import { READ_ONLY_TEMPLATES } from './readOnlyTemplates'
 import { fetchRepoFileText, getFileSha, upsertFile } from './github'
-import { getFriendlyGithubError } from './githubFriendlyMessages'
 import {
   MARKER_END,
   MARKER_START,
@@ -19,18 +17,38 @@ import {
 export const PAGES_SETUP_HINT =
   'Enable GitHub Pages: Settings → Pages → Source → GitHub Actions, then run “Deploy blog to GitHub Pages” in Actions.'
 
-async function putIfMissing({ token, owner, repo, branch, path, content, message, created }) {
-  if (await getFileSha({ token, owner, repo, path, branch })) return
-  await upsertFile({ token, owner, repo, path, branch, content, message, sha: null })
-  created.push(path)
+export const WORKFLOW_PERMISSION_WARNING =
+  'Blog files were created, but the GitHub Pages workflow could not be added. Your GitHub token may need workflow permission. Add workflow permission to your token or create .github/workflows/deploy-blog-pages.yml manually.'
+
+/** @typedef {'created' | 'found' | 'failed'} BootstrapFileStatus */
+
+/**
+ * @param {Array<{ path: string, status: BootstrapFileStatus }>} fileLog
+ */
+export function formatBootstrapStatusMessage(fileLog) {
+  return fileLog
+    .map(({ path, status }) => {
+      if (status === 'created') return `${path} created`
+      if (status === 'found') return `${path} found`
+      return `${path} missing`
+    })
+    .join(' · ')
 }
 
-function workflowYaml(branch) {
+export function buildPagesWorkflowYaml(branch = 'main') {
   const b = String(branch ?? '').trim() || 'main'
   const branchRef = /^[a-zA-Z0-9._/-]+$/.test(b) ? b : `"${b.replace(/"/g, '\\"')}"`
-  return READ_ONLY_TEMPLATES.githubPagesWorkflowYaml
-    .replace(/\{\{BLOG_DIR\}\}/g, BLOG_ROOT)
-    .replace(/\{\{BRANCH\}\}/g, branchRef)
+  return READ_ONLY_TEMPLATES.githubPagesWorkflowYaml.replace(/\{\{BRANCH\}\}/g, branchRef)
+}
+
+async function recordFile({ token, owner, repo, branch, path, content, message, fileLog }) {
+  const sha = await getFileSha({ token, owner, repo, path, branch })
+  if (sha) {
+    fileLog.push({ path, status: 'found' })
+    return
+  }
+  await upsertFile({ token, owner, repo, path, branch, content, message, sha: null })
+  fileLog.push({ path, status: 'created' })
 }
 
 function createIndexHtml() {
@@ -61,48 +79,55 @@ function prepareIndex(html) {
   return { html: h, modified }
 }
 
-/** Ensure blog/, starter files, and the Pages workflow exist. */
+/**
+ * Create blog/ starter files and .github/workflows/deploy-blog-pages.yml at repo root.
+ */
 export async function bootstrapBlogSite({ token, owner, repo, branch }) {
-  const created = []
-  const warnings = []
+  /** @type {Array<{ path: string, status: BootstrapFileStatus }>} */
+  const fileLog = []
+  let workflowWarning = null
+  let workflowOk = false
 
-  await putIfMissing({
+  await recordFile({
     token,
     owner,
     repo,
     branch,
     path: BLOG_STYLE,
     content: READ_ONLY_TEMPLATES.stylesCss,
     message: 'Add blog/style.css',
-    created,
+    fileLog,
   })
-  await putIfMissing({
+  await recordFile({
     token,
     owner,
     repo,
     branch,
     path: BLOG_POSTS_GITKEEP,
     content: '',
     message: 'Create blog/posts',
-    created,
+    fileLog,
   })
-  await putIfMissing({
+  const postsDirStatus = fileLog[fileLog.length - 1]?.status ?? 'failed'
+  fileLog.push({ path: 'blog/posts/', status: postsDirStatus })
+  await recordFile({
     token,
     owner,
     repo,
     branch,
     path: BLOG_NOJEKYLL,
     content: '',
     message: 'Add blog/.nojekyll',
-    created,
+    fileLog,
   })
 
   let indexCreated = false
   let indexModified = false
   let indexText = ''
   let indexSha = null
 
-  if (!(await getFileSha({ token, owner, repo, path: BLOG_INDEX, branch }))) {
+  const indexShaBefore = await getFileSha({ token, owner, repo, path: BLOG_INDEX, branch })
+  if (!indexShaBefore) {
     indexText = createIndexHtml()
     await upsertFile({
       token,
@@ -114,10 +139,11 @@ export async function bootstrapBlogSite({ token, owner, repo, branch }) {
       message: 'Create blog/index.html',
       sha: null,
     })
-    created.push(BLOG_INDEX)
+    fileLog.push({ path: BLOG_INDEX, status: 'created' })
     indexCreated = true
     indexSha = await getFileSha({ token, owner, repo, path: BLOG_INDEX, branch })
   } else {
+    fileLog.push({ path: BLOG_INDEX, status: 'found' })
     const res = await fetchRepoFileText({ token, owner, repo, path: BLOG_INDEX, branch })
     indexText = res.text
     indexSha = res.sha
@@ -126,31 +152,46 @@ export async function bootstrapBlogSite({ token, owner, repo, branch }) {
     indexModified = prep.modified
   }
 
-  try {
-    await putIfMissing({
-      token,
-      owner,
-      repo,
-      branch,
-      path: PAGES_WORKFLOW,
-      content: workflowYaml(branch),
-      message: 'Add GitHub Pages workflow',
-      created,
-    })
-  } catch (err) {
-    const { friendly } = getFriendlyGithubError(err, 'publish')
-    warnings.push(`${friendly} Add ${PAGES_WORKFLOW} manually if needed.`)
+  // Workflow lives at repo root (.github/workflows/…), not under blog/
+  const workflowSha = await getFileSha({ token, owner, repo, path: PAGES_WORKFLOW, branch })
+  if (workflowSha) {
+    fileLog.push({ path: PAGES_WORKFLOW, status: 'found' })
+    workflowOk = true
+  } else {
+    try {
+      await upsertFile({
+        token,
+        owner,
+        repo,
+        path: PAGES_WORKFLOW,
+        branch,
+        content: buildPagesWorkflowYaml(branch),
+        message: 'Add GitHub Pages workflow for blog/',
+        sha: null,
+      })
+      const verified = await getFileSha({ token, owner, repo, path: PAGES_WORKFLOW, branch })
+      if (verified) {
+        fileLog.push({ path: PAGES_WORKFLOW, status: 'created' })
+        workflowOk = true
+      } else {
+        fileLog.push({ path: PAGES_WORKFLOW, status: 'failed' })
+        workflowWarning = WORKFLOW_PERMISSION_WARNING
+      }
+    } catch {
+      fileLog.push({ path: PAGES_WORKFLOW, status: 'failed' })
+      workflowWarning = WORKFLOW_PERMISSION_WARNING
+    }
   }
 
-  const workflowCreated = created.includes(PAGES_WORKFLOW)
-
   return {
     indexText,
     indexSha,
     indexCreated,
     indexModified,
-    created,
-    warnings,
-    pagesSetupHint: workflowCreated ? PAGES_SETUP_HINT : null,
+    fileLog,
+    bootstrapStatusMessage: formatBootstrapStatusMessage(fileLog),
+    workflowOk,
+    workflowWarning,
+    pagesSetupHint: workflowOk ? PAGES_SETUP_HINT : null,
   }
 }

templates/github-pages-blog.yml

@@ -1,12 +1,5 @@
-# Deploys the blog/ folder (blog/index.html as the site homepage) to GitHub Pages.
-#
-# If GitHub Pages is not set up yet on this repository:
-#   1. Push this file to your default branch.
-#   2. Repo → Settings → Pages → Build and deployment → Source: "GitHub Actions".
-#   3. Re-run this workflow from the Actions tab if the first run fails before step 2.
-#
-# Project site URL: https://<owner>.github.io/<repo>/
-# User/org site (repo named <owner>.github.io): https://<owner>.github.io/
+# Deploys blog/ to GitHub Pages (blog/index.html is the site homepage).
+# One-time: repo Settings → Pages → Build and deployment → Source → GitHub Actions.
 
 name: Deploy blog to GitHub Pages
 
@@ -21,24 +14,24 @@ permissions:
   id-token: write
 
 concurrency:
-  group: pages
+  group: "pages"
   cancel-in-progress: false
 
 jobs:
   deploy:
-    runs-on: ubuntu-latest
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Configure GitHub Pages
+      - name: Setup Pages
         uses: actions/configure-pages@v5
-      - name: Upload site artifact (blog/)
+      - name: Upload blog artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: {{BLOG_DIR}}
+          path: ./blog
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4