Documentation Update for First Run ➔ gh-cache Branch, cache_key File, and JSON Escaping Guidance
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- github-actions
- 领域
- ci-cd, documentation
调研方向
首先检查 action.yml 和 workflow 的 cache_key 设置，然后确定首次运行要求记录在哪里。记录创建 gh-cache 分支和匹配的缓存文件，并验证报告输出能够处理 HTML 引号，而不会导致 workflow 以代码 2 退出。
由索引模型根据 Issue 内容生成。
描述
Great tool! It works for me now. However, I ran into a few undocumented setup issues during the first run that caused the workflow to exit with code 2.
1️⃣ Missing gh-cache branch
The first run failed with:
Branch
gh-cachedoes not exist
Creating a branch named gh-cache resolved this.
2️⃣ Missing cache file matching cache_key
Next error on report:
cache-key-valuenot found in cache
Creating and pushing an empty file onto the gh-cache branch whose name matches the cache_key value in the workflow YAML fixed this issue.
3️⃣ JSON escaping issue in action.yml file in codebase:
Final error in report:
The line echo "issues=$issues" >> "$GITHUB_OUTPUT" fails whenever HTML contains quotations. This likely happens due to the line trying to echo out unescaped quotes.
Proposed fix:
issues_escaped=$(echo "$issues" | jq -c . | sed 's/%/%25/g; s/\r/%0D/g; s/\n/%0A/g')
echo "issues=$issues_escaped" >> "$GITHUB_OUTPUT"
- 主要语言
- TypeScript
- 星标
- 375
- 派生
- 42
- 平均合并
- 1 天 7 小时
- 30 天内合并 PR
- 6
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/accessibility-scanner 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
github/accessibility-scanner#264 ·
-
难度 3/5 1-2 天 新手友好度 48/100
github/accessibility-scanner#260 ·
-
难度 2/5 1-3 小时 新手友好度 50/100
github/accessibility-scanner#259 ·
-
难度 4/5 3-5 天 新手友好度 58/100
github/accessibility-scanner#245 ·
-
Sitemap Support未关闭
难度 5/5 一周以上 新手友好度 35/100
github/accessibility-scanner#244 ·
查看 github/accessibility-scanner 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 85/100
modelcontextprotocol/ext-skills#156 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
MystenLabs/MemWal#1104 · 1 条评论 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
Effect-TS/effect#8728 · 1 条评论 ·
维护者通常 1 天内回复
-
account-pool bug
难度 2/5 1-3 小时 新手友好度 76/100
lidge-jun/opencodex#6571 · 1 条评论 ·
维护者通常 1 天内回复
-
check:passed streams:add
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 1 天内回复