Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[workshop-sync] side-quest-05-03-two-file-structure.md: sample workflow and cron examples don't match documented gh-aw behavior

已关闭 适合新手
#4,569 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
88/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
github-actions, markdown, yaml
领域
documentation

调研方向

打开 workshop/side-quest-05-03-two-file-structure.md。在“Read a sample .md source file”一节中,为 frontmatter 添加一个带有 create-issue 的 safe-outputs 块,使其与 digest 任务保持一致。在“What gh aw compile generates”一节中,将整点的 cron 值 '0 8 * * *' 替换为分散的值,例如 '37 8 * * *'。当两个代码示例都与 issue 中引用的 gh-aw 行为一致,且文件渲染正确时,即完成。

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

描述

documentation

Workshop file reviewed

workshop/side-quest-05-03-two-file-structure.md

Problem 1 — sample .md source is missing safe-outputs

The "Read a sample .md source file" section shows:

---
on:
  schedule: daily
permissions:
  issues: read
---

Review all open issues, summarize the key themes, and post a short digest as a new issue.

The task brief tells the agent to "post a short digest as a new issue," but the frontmatter has no safe-outputs: block (e.g. create-issue:). Per the gh-aw docs, agent jobs are read-only — all writes (including creating issues) must go through a declared safe-outputs: entry; permissions: issues: read alone cannot create an issue.

Reference: gh-aw reference example pairs the comment/create instruction with a safe-outputs: block, e.g.:

safe-outputs:
  create-issue:

Suggested fix: Add a safe-outputs: block to the sample frontmatter, e.g.:

---
on:
  schedule: daily
permissions:
  issues: read
safe-outputs:
  create-issue:
---

Review all open issues, summarize the key themes, and post a short digest as a new issue.

Problem 2 — generated .lock.yml cron example uses a round, non-scattered time

The "What gh aw compile generates" section shows:

on:
  schedule:
    - cron: "0 8 * * *"
  workflow_dispatch:

Per the gh-aw triggers reference: "The compiler converts fuzzy schedules to deterministic cron (e.g., daily on weekdays → 43 5 * * 1-5), scatters execution to avoid load spikes." A round value like 0 8 * * * contradicts this documented scattering behavior and could mislead learners about what gh aw compile actually produces.

Suggested fix: Use a scattered (non-round) example, e.g. cron: "37 8 * * *", consistent with how the compiler actually generates scattered cron values from schedule: daily.

Reference

  • gh-aw triggers reference, "Fuzzy Scheduling" section
  • gh-aw workflow-file-format guidance on safe-outputs routing for writes

Generated by 🔍 Workshop Sync Check · copilot · auto · 173.7 AIC · ⌖ 0.605 AIC · ⊞ 9.2K · ◷

  • expires on Oct 15, 2026, 4:57 AM UTC
主要语言
JavaScript
星标
53
派生
35
平均合并
1 天 5 小时
30 天内合并 PR
16

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

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

githubnext/gh-aw-workshop 的其他 Issue

查看 githubnext/gh-aw-workshop 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

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