Skip to content

Commit 0292d37

Browse files
docs: unbloat examples/project-tracking.md (#29243)
1 parent 208a6d9 commit 0292d37

1 file changed

Lines changed: 7 additions & 59 deletions

File tree

docs/src/content/docs/examples/project-tracking.md

Lines changed: 7 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar:
55
badge: { text: 'Project', variant: 'tip' }
66
---
77

8-
The `update-project` and `create-project-status-update` safe-output tools enable automatic tracking of workflow-created items in GitHub Projects boards. Configure these tools in the `safe-outputs` section of your workflow frontmatter to enable project management capabilities including item addition, field updates, and status reporting.
8+
Use `update-project` and `create-project-status-update` safe-outputs to automatically track workflow items in GitHub Projects boards, with support for field updates and status reporting.
99

1010
## Quick Start
1111

@@ -28,10 +28,6 @@ safe-outputs:
2828
---
2929
```
3030

31-
This enables:
32-
- **update-project** - Add items to projects, update fields (status, priority, etc.)
33-
- **create-project-status-update** - Post status updates to project boards
34-
3531
## Configuration
3632

3733
### Update Project Configuration
@@ -56,7 +52,7 @@ Supported operations: `add` (add items), `update` (update fields), `create_field
5652

5753
### Project Status Update Configuration
5854

59-
Configure `create-project-status-update` to post status updates — useful for progress reports, milestone summaries, and workflow health indicators:
55+
Configure `create-project-status-update` to post project status updates:
6056

6157
```yaml
6258
safe-outputs:
@@ -66,13 +62,6 @@ safe-outputs:
6662
github-token: ${{ secrets.GH_AW_PROJECT_GITHUB_TOKEN }}
6763
```
6864

69-
| Field | Type | Default | Description |
70-
|-------|------|---------|-------------|
71-
| `project` | string | (required) | GitHub Project URL for update-project or create-project-status-update |
72-
| `max` | integer | 10 | Maximum operations per run (update-project) or 1 (create-project-status-update) |
73-
| `github-token` | string | `GITHUB_TOKEN` | Custom token with Projects permissions |
74-
| `views` | array | - | Optional auto-created views for update-project (with name, layout, filter) |
75-
7665
See [Safe Outputs: Project Board Updates](/gh-aw/reference/safe-outputs/#project-board-updates-update-project) for complete configuration details.
7766

7867
### Authentication
@@ -160,21 +149,10 @@ When a pull request is opened or reviews are requested:
160149
- Default → "Low"
161150
```
162151

163-
## How this fits
164-
165-
- **Projects & Monitoring:** Use `update-project` to track work items and `create-project-status-update` to publish run summaries.
166-
- **Orchestration:** An orchestrator can dispatch workers and use the same project safe-outputs to keep a shared board updated.
167-
168-
See:
169-
- [Projects & Monitoring](/gh-aw/patterns/monitoring/)
170-
- [Orchestration](/gh-aw/patterns/orchestration/)
171-
172152
## Common Patterns
173153

174154
### Progressive Status Updates
175155

176-
Move items through workflow stages:
177-
178156
```aw
179157
Analyze the issue and determine its current state:
180158
- If new and unreviewed → status="Needs Triage"
@@ -187,8 +165,6 @@ Update the project item with the appropriate status.
187165

188166
### Priority Assignment
189167

190-
Set priority based on content analysis:
191-
192168
```aw
193169
Examine the issue for urgency indicators:
194170
- Contains "critical", "urgent", "blocker" → priority="High"
@@ -200,8 +176,6 @@ Update the project item with the assigned priority.
200176

201177
### Field-Based Routing
202178

203-
Use custom fields for workflow routing:
204-
205179
```aw
206180
Determine the team that should handle this issue:
207181
- Security-related → team="Security"
@@ -214,41 +188,15 @@ Update the project item with the team field.
214188

215189
## Troubleshooting
216190

217-
### Items Not Added to Project
218-
219-
**Symptoms**: Workflow runs successfully but items don't appear in project board
220-
221-
**Solutions**:
222-
- Verify project URL is correct (check browser address bar)
223-
- Confirm token has Projects: Read & Write permissions
224-
- Check that organization allows Projects access for the token
225-
- Review workflow logs for safe_outputs job errors
226-
227-
### Permission Errors
228-
229-
**Symptoms**: Workflow fails with "Resource not accessible" or "Insufficient permissions"
230-
231-
**Solutions**:
232-
- For organization projects: Use fine-grained PAT with organization Projects permission
233-
- For user projects: Use classic PAT with `project` scope
234-
- Ensure token is stored in correct secret name
235-
- Verify repository settings allow Actions to access secrets
236-
237-
### Token Not Resolved
238-
239-
**Symptoms**: Workflow fails with "invalid token" or token appears as literal string
240-
241-
**Solutions**:
242-
- Use GitHub expression syntax: `${{ secrets.GH_AW_PROJECT_GITHUB_TOKEN }}`
243-
- Don't quote the expression in YAML
244-
- Ensure secret name matches exactly (case-sensitive)
245-
- Check secret is set at repository or organization level
191+
| Issue | Symptom | Solution |
192+
|-------|---------|----------|
193+
| Items not added | Items don't appear despite a successful run | Verify project URL, confirm token has Projects: Read & Write permission, review `safe_outputs` job logs |
194+
| Permission errors | "Resource not accessible" or "Insufficient permissions" | Use fine-grained PAT with org Projects permission, or classic PAT with `project` scope; verify secret name and repository settings |
195+
| Token not resolved | "invalid token" or literal `${{...}}` string in output | Use `${{ secrets.GH_AW_PROJECT_GITHUB_TOKEN }}` syntax without quotes; check secret name is exact (case-sensitive) |
246196

247197
## See Also
248198

249199
- [Safe Outputs Reference](/gh-aw/reference/safe-outputs/) - Complete safe-outputs documentation
250-
- [update-project](/gh-aw/reference/safe-outputs/#project-board-updates-update-project) - Detailed update-project configuration
251-
- [create-project-status-update](/gh-aw/reference/safe-outputs/#project-status-updates-create-project-status-update) - Status update configuration
252200
- [Project token authentication](/gh-aw/patterns/project-ops/#project-token-authentication) - Token setup guide
253201
- [Projects & Monitoring](/gh-aw/patterns/monitoring/) - Design pattern guide
254202
- [Orchestration](/gh-aw/patterns/orchestration/) - Design pattern guide

0 commit comments

Comments
 (0)