GitHub Wiki 发布
将请求的材料发布到仓库的现有 Wiki。保持内容生成与发布分离:使用提供的页面、报告和资产,根据需要调整链接和导航。遵循目标项目的规则,不要引入其他项目的约定。
确定目标与范围
- 根据请求和仓库上下文,解析 GitHub 主机、仓库、Wiki URL、源文件和预期的页面名称。仅询问那些会实质性改变发布结果的未解决选择。
- 区分准备和发布。明确的发布请求授权指定的 Wiki 更新;不要再次询问相同的操作。仅请求草稿或评估并不授权推送。
- 首先探索相关连接器的能力。如果它们无法充分管理 Wiki 内容和资产,请使用 Wiki 的独立 Git 仓库。简要说明备选方案。普通的仓库 Contents API 无法处理 Wiki 仓库。
- 使用现有的已验证连接或 Git 凭据验证访问权限。切勿将凭据嵌入 URL、页面或保留的证据中。未经验证的 404 并不能证明私有 Wiki 不存在。
- 如果 Wiki Git 仓库不存在,请检查 Wiki 是否被禁用或需要通过 GitHub 创建其第一个页面。不要作为副作用启用仓库功能或更改访问权限。尽可能使用授权的第一个页面创建;否则报告具体的缺失前提条件。
准备有界更新
对于 Git 发布,请阅读 Git 过程。使用全新的临时克隆,发现其实际默认分支,并在写入前读取现有的目标页面、首页和侧边栏。
- 将每个源文件映射到目标页面或资产。保留无关页面、手工编写的部分和导航。不存在的源文件不是删除指令。仅当页面属于请求的更新时,才替换整个页面;对于共享的首页/侧边栏内容,使用窄幅编辑。保持现有链接,避免在重复运行时出现重复的导航条目。
- 明确以 UTF-8 编码读写文本。逐字节复制二进制资产。不要静默修复源事实或从不同的数据集刷新报告。保留其实际日期、来源和局限性;仅当重新生成在范围内时,才使用适当的上游生成器。
- 为 Wiki 的实际目标重写链接。仓库相对链接在移动页面后可能会失效。复制引用的资产或链接到可访问的仓库修订版;不要保留本地路径、未发布的分支链接或不可访问的外部资源。
- Wiki 将页面文件名显示为其标题,因此以自身 H1 标题开头的页面会显示两次 H1。删除该 H1 并以它命名页面,仅当 H1 与页面名称故意不同(例如首页)时才保留 H1;更新导航以使用派生名称。首页在
/wiki提供服务,因此其相对链接在 Wiki 外部解析:对图像、页面链接和侧边栏使用绝对 Wiki URL。 - 使用带有有意义替代文本的支持的内联图像。对于 HTML 报告或动画/交互式图表,当 Wiki 无法渲染时,提供有用的静态预览和指向原始工件的链接。不要将可下载的 HTML 描述为 Wiki 内提供的应用程序。当生成新图稿在范围内时,遵循项目特定的图表工具;此技能不要求特定的生成器。
- 检查本地链接和资产、有代表性的非 ASCII 文本以及确切更改的路径。检查最终差异以查找意外的删除、覆盖的内容、凭据和生成的残留文件。保留临时克隆和本地证据,除非用户或项目要求在其中保留源文件。
发布与验证
仅在用户现有授权范围内应用发布。Wiki 更新不授权推送应用程序分支、更改问题、部署站点、安排同步或安装 CI。
- 仅提交预期的 Wiki 路径,然后按照 Git 过程中的描述获取和协调并发更改。正常推送到 Wiki 发现的默认分支。切勿强制推送以覆盖其他作者。
- 在拒绝时,获取并检查一次。整合兼容的编辑并重新检查完整的差异。如果相同的冲突再次发生,意图无法解决,或访问失败,则停止重试并保留可恢复的克隆,并附上精确的阻塞原因。失败时不要删除它。
- 对照实时远程验证已发布的提交。仅凭干净的工作树并不能证明本地提交已被推送。
- 在可用时通过经过身份验证的浏览器检查实际服务的页面:页面文本、有代表性的 Unicode、导航、链接、图像加载和可读性。对于图表,将渲染结果与源事实进行比较。当内联预览模糊标签时,检查全尺寸图像。在范围内纠正观察到的缺陷并重新检查受影响的内容。
- 如果无法进行经过身份验证的渲染验证,请分别报告发布和远程验证与未运行的浏览器检查。不要声称从本地文件、HTTP 响应或成功推送中通过渲染检查。
报告页面 URL、已发布的修订版本、实质性更改、执行的检查以及任何未解决的限制。在工作仍未发布时保留恢复路径。不要添加新的批准门、内容模式、项目生命周期或测试制度。