Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions .github/workflows/daily-news.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

56 changes: 56 additions & 0 deletions .github/workflows/daily-news.md
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,62 @@ If insufficient data is available (less than 7 days):

- Include a short haiku at the end of the report to help orient the team to the season of their work.

## 📝 Report Formatting Guidelines

Follow these formatting guidelines to create well-structured, readable news reports:

### 1. Header Levels
**Use h3 (###) or lower for all headers in your news report to maintain proper document hierarchy.**

When creating your news report:
- Use `###` (h3) for main sections (e.g., "### Top News", "### Trend Analysis")
- Use `####` (h4) for subsections (e.g., "#### Recent Releases", "#### Community Engagement")
- Never use `##` (h2) or `#` (h1) in the report body - these are reserved for titles

### 2. Progressive Disclosure
**Wrap detailed news analysis and long article sections in `<details><summary><b>Section Name</b></summary>` tags to improve readability.**

Use collapsible sections for:
- Detailed article analysis
- Verbose commit logs or detailed change descriptions
- Additional news items that provide extra context
- Extended lists of issues or pull requests

Always keep critical information visible:
- Brief summary of top news items
- Key headlines with links
- High-level trend insights
- Important recommendations or takeaways

Example structure:
```markdown
<details>
<summary><b>Full News Analysis</b></summary>

[Long detailed content here...]

</details>
```

### 3. Suggested Report Structure

Structure your news report with these sections:

1. **Brief Summary** (always visible): 1-2 paragraphs highlighting the most important news
2. **Key Headlines** (always visible): Top 3-5 headlines with links to issues/PRs/releases
3. **📈 Trend Analysis** (always visible): Include the 2 required charts with brief analysis
4. **Detailed Article Analysis** (in `<details>` tags): Deep dive into specific items
5. **Additional News Items** (in `<details>` tags): Secondary stories and updates
6. **Recommendations & Takeaways** (always visible): Actionable insights for the team

### Design Principles

Your reports should:
- **Build trust through clarity**: Most important info immediately visible
- **Exceed expectations**: Add helpful context, summaries, and insights
- **Create delight**: Use progressive disclosure to reduce overwhelm
- **Maintain consistency**: Follow the same patterns as other reporting workflows

- In a note at the end of the report, include a log of:
* All web search queries you used (if any)
* All files you read from `/tmp/gh-aw/daily-news-data/`
Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/templates/create-agentic-workflow.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/cli/templates/create-shared-agentic-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ You are a conversational chat agent that interacts with the user to design secur
**Move Write Operations to Safe Outputs**
- Never grant direct write permissions in shared components
- Use `safe-outputs:` configuration for all write operations
- Common safe outputs: `create-issue`, `add-comment`, `create-pull-request`, `update-issue`
- Common safe outputs: `create-issue`, `add-comment`, `create-pull-request`, `update-issue`, `dispatch-workflow`
- Let consuming workflows decide which safe outputs to enable

**Process Agent Output in Safe Jobs**
Expand Down
8 changes: 8 additions & 0 deletions pkg/cli/templates/github-agentic-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,14 @@ The YAML frontmatter supports these fields:
target-repo: "owner/repo" # Optional: cross-repository
```
Publishes workflow artifacts to an orphaned git branch for persistent storage. Default allowed extensions include common non-executable types. Maximum file size is 50MB (51200 KB).
- `dispatch-workflow:` - Trigger other workflows with inputs
```yaml
safe-outputs:
dispatch-workflow:
workflows: [workflow-name] # Required: list of workflow names to allow
max: 3 # Optional: max dispatches (default: 1, max: 3)
```
Triggers other agentic workflows in the same repository using workflow_dispatch. Agent output includes `workflow_name` (without .md extension) and optional `inputs` (key-value pairs). Not supported for cross-repository operations.
- `create-code-scanning-alert:` - Generate SARIF security advisories
```yaml
safe-outputs:
Expand Down