quarto publish gh-pages cannot bootstrap a repository with no gh-pages branch (docs say it creates one)

未关闭
#15,221 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
48/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
git, github, javascript
领域
backend, cli

调研方向

Start at the quarto publish gh-pages command’s resolveDeployment path, which the error trace locates in the bundled quarto.js, and trace how it checks for a remote gh-pages branch. Reproduce with a website project in a subdirectory and an origin that has only main; compare local and CI publishing. Done means first publish creates the branch as documented, or the error explains a working bootstrap procedure.

由索引模型根据 Issue 内容生成。

描述

documentation publishing-github
Checks
  • I have searched the existing issues and discussions, and this has not been reported.
  • I have tested with the latest stable version of Quarto.
System

Linux (x86_64), Quarto 1.10.19 stable, git 2.x, remote over HTTPS with a credential helper.

Expected

Per https://quarto.org/docs/publishing/github-pages.html ("Source Branch"):

quarto publish gh-pages automatically creates a gh-pages branch (locally and on the remote) on its first run if one does not already exist.

Actual

Running exactly that first run locally fails, and says to do the thing that just failed:

$ quarto publish gh-pages --no-prompt --no-browser
ERROR: Unable to publish to GitHub Pages (the remote origin does not have a branch named
"gh-pages". Use first `quarto publish gh-pages` locally to initialize the remote repository
for publishing.)
    at resolveDeployment (file:///opt/quarto/bin/quarto.js:173771:13)

Answering the confirmation prompt interactively (printf 'y\n' | quarto publish gh-pages --no-browser) gives the same error. The same error also aborts quarto-dev/quarto-actions/publish@v2 with target: gh-pages, so the documented CI recipe cannot bootstrap a new repository either: the job fails at the publish step and no gh-pages branch is ever created.

Repository shape that may matter
  • Git repository root: /repo, with the Quarto project in a subdirectory: /repo/05_website/_quarto.yml (project.type: website, output-dir: _site, website.site-url set to the project-page URL).
  • Branches on origin: main only. No gh-pages.
  • No _publish.yml anywhere (i.e. genuinely a first run).

So the case is: valid website project, canonical site-url configured, publishing source absent. That is precisely the case the docs say Quarto initialises.

What we did to get unblocked

Created the branch by hand once, with git plumbing so the working tree was untouched:

empty=$(git hash-object -t tree /dev/null)
commit=$(git commit-tree "$empty" -m "Initialize gh-pages branch for Quarto publishing")
git push origin "$commit:refs/heads/gh-pages"

After that, the same quarto publish gh-pages invocation (from CI) renders and deploys normally, GitHub picks the branch up and Pages reports status: built. So the failure is specific to creating the branch, not to the deployment itself.

Two asks
  1. If branch creation is conditional on something (project at the repository root? a remote helper? an interactive TTY? _publish.yml?), please document the condition; the current error message points at a step that cannot be performed, because performing it produces the same error.
  2. Otherwise, either create the branch on first run as documented, or replace the message with the three-command manual bootstrap above.

Happy to test a pre-release against this repository shape.

主要语言
JavaScript
星标
6.1k
派生
476
平均合并
16 小时 42 分钟
30 天内合并 PR
115

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

quarto-dev/quarto-cli 的其他 Issue

查看 quarto-dev/quarto-cli 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。