Skip to content

Commit d3ff517

Browse files
committed
update docs and workflow
1 parent 80cbd38 commit d3ff517

16 files changed

Lines changed: 33 additions & 127 deletions

docs/ci-doctor.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,11 @@ The [CI Doctor workflow](../workflows/ci-doctor.md?plain=1) monitors your GitHub
1111
gh extension install github/gh-aw
1212

1313
# Add the CI Doctor workflow to your repository
14-
gh aw add githubnext/agentics/ci-doctor
14+
gh aw add-wizard githubnext/agentics/ci-doctor
1515
```
1616

1717
This walks you through adding the workflow to your repository.
1818

19-
After adding, the workflow will automatically trigger when monitored CI workflows fail. You cannot start this workflow manually as it responds to workflow failure events.
20-
21-
**Mandatory Checklist**
22-
23-
* [ ] If in a fork, enable GitHub Actions and Issues in the fork settings
24-
2519
## Configuration
2620

2721
You can specify which workflows to monitor (currently monitors "Daily Perf Improver" and "Daily Test Improver") by editing the workflow directly.

docs/daily-accessibility-review.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,14 @@ The [daily accessibility review workflow](../workflows/daily-accessibility-revie
1111
gh extension install github/gh-aw
1212

1313
# Add the Daily Accessibility Review workflow to your repository
14-
gh aw add githubnext/agentics/daily-accessibility-review
14+
gh aw add-wizard githubnext/agentics/daily-accessibility-review
1515
```
1616

1717
This walks you through adding the workflow to your repository.
1818

19-
**Mandatory Checklist**
20-
21-
* [ ] If in a fork, enable GitHub Actions and Issues in the fork settings
22-
2319
## Configuration
2420

25-
This workflow requires no configuration and works out of the box. You can use local configuration to specify which accessibility standards to check (e.g., WCAG 2.1, WCAG 2.2), types of accessibility issues to prioritize, and reporting format. Local configuration can be done in `.github/workflows/agentics/daily-accessibility-review.config.md`.
21+
This workflow requires no configuration and works out of the box.
2622

2723
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
2824

docs/daily-dependency-updates.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The [daily dependency updater workflow](../workflows/daily-dependency-updates.md
1111
gh extension install github/gh-aw
1212

1313
# Add the Daily Dependency Updater workflow to your repository
14-
gh aw add githubnext/agentics/daily-dependency-updates
14+
gh aw add-wizard githubnext/agentics/daily-dependency-updates
1515
```
1616

1717
This walks you through adding the workflow to your repository. After merging the PR and syncing to main, you can start a run of this workflow immediately by running:
@@ -20,31 +20,9 @@ This walks you through adding the workflow to your repository. After merging the
2020
gh aw run daily-dependency-updates
2121
```
2222

23-
❗IMPORTANT: GitHub Actions runs will **not** trigger on commits pushed by this workflow and will **not** tell you that CI has not been run unless you have enabled a specific custom check for this condition. **You must open/close the PR or hit "Update branch" if offered to trigger CI.Yes it's painful and yes it's just something you need to be aware of.
24-
25-
**Mandatory Checklist**
26-
27-
* [ ] I have read the notes on coding tasks in the [main README](../README.md) and understand the implications.
28-
29-
* [ ] I am a repository admin or have sufficient permissions, and am happy for the safe-outputs portion of this workflow to push new branches to the repository.
30-
31-
* [ ] I have enabled "Allow GitHub Actions to create and approve pull requests" in the repository settings under "Actions > General"
32-
33-
* [ ] I have considered enabling "Always suggest updating pull request branches" in the repository settings
34-
35-
* [ ] If in a fork, I have enabled "GitHub Actions" and "GitHub Issues" in the fork repository settings
36-
37-
* [ ] I will review all pull requests very carefully, and carefully monitor the repository.
38-
39-
* [ ] I will operate this demonstrator for a time-limited period only (the default is 48h).
40-
41-
* [ ] I understand that GitHub Actions runs will **not** trigger on pull requests created by this workflow, see above.
42-
4323
## Configuration
4424

45-
This workflow requires no configuration and works out of the box. You can use local configuration to specify dependency management tools (npm, pip, maven, etc.), customize dependency update strategies and version constraints, configure which dependencies to include/exclude from automated updates. Local configuration can be done in `.github/workflows/agentics/daily-dependency-updates.config.md`.
46-
47-
25+
This workflow requires no configuration and works out of the box.
4826

4927
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
5028

docs/daily-perf-improver.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The [daily performance improver workflow](../workflows/daily-perf-improver.md?pl
1111
gh extension install github/gh-aw
1212

1313
# Add the Daily Performance Improver workflow to your repository
14-
gh aw add githubnext/agentics/daily-perf-improver
14+
gh aw add-wizard githubnext/agentics/daily-perf-improver
1515
```
1616

1717
This walks you through adding the workflow to your repository and running the workflow for the first time.
@@ -28,20 +28,12 @@ To run repeatedly (at most one instance running at a time and sending a trigger
2828
gh aw run daily-perf-improver --repeat 180
2929
```
3030

31-
**Mandatory Checklist**
32-
33-
* [ ] I understand that, by default, the agentic portion of this workflow will generate and run bash commands in the confine of the GitHub Actions VM, with network access.
34-
35-
* [ ] I will review all pull requests very carefully, and carefully monitor the repository.
36-
3731
## Configuration
3832

3933
1. The first run of the workflow will produce a pull request with inferred action pre-steps that need approval
4034

4135
2. The first run of the workflow will also create an issue in the repository with a plan for improving performance. You can comment on this issue to provide feedback or adjustments to the plan. Comments will not be picked up until the next run.
4236

43-
3. Use local configuration to specify performance testing tools and benchmarking frameworks, optimization targets, performance metrics, and profiling strategies. Local configuration can be done in `.github/workflows/agentics/daily-perf-improver.config.md`.
44-
4537
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
4638

4739
## What it reads from GitHub

docs/daily-plan.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,14 @@ The [daily plan workflow](../workflows/daily-plan.md?plain=1) will run daily to
1111
gh extension install github/gh-aw
1212

1313
# Add the Daily Plan workflow to your repository
14-
gh aw add githubnext/agentics/daily-plan
14+
gh aw add-wizard githubnext/agentics/daily-plan
1515
```
1616

1717
This walks you through adding the workflow to your repository and running the workflow for the first time.
1818

19-
**Mandatory Checklist**
20-
21-
* [ ] If in a fork, enable GitHub Actions and Issues in the fork settings
22-
2319
## Configuration
2420

25-
This workflow requires no configuration and works out of the box. You can use local configuration to specify planning focus areas, reporting format, and frequency. Local configuration can be done in `.github/workflows/agentics/daily-plan.config.md`.
21+
This workflow requires no configuration and works out of the box.
2622

2723
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
2824

docs/daily-progress.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The [daily progress workflow](../workflows/daily-progress.md?plain=1) is an auto
1111
gh extension install github/gh-aw
1212

1313
# Add the Daily Progress workflow to your repository
14-
gh aw add githubnext/agentics/daily-progress
14+
gh aw add-wizard githubnext/agentics/daily-progress
1515
```
1616

1717
This walks you through adding the workflow to your repository.
@@ -22,19 +22,9 @@ You can start a run of this workflow immediately by running:
2222
gh aw run daily-progress
2323
```
2424

25-
**Mandatory Checklist**
26-
27-
* [ ] I understand that this workflow will generate and run bash commands in the confine of the GitHub Actions VM, with network access.
28-
29-
* [ ] I will review all pull requests and issues created by this workflow very carefully, and carefully monitor the repository.
30-
3125
## Configuration
3226

33-
This workflow requires no configuration and works out of the box. However, you can customize it as follows:
34-
35-
1. **Local configuration**: Customize development focus areas, coding standards, and workflow behavior. Local configuration can be done in `.github/workflows/agentics/daily-progress.config.md`.
36-
37-
2. **Build steps**: The workflow will automatically create a build configuration file at `.github/actions/daily-progress/build-steps/action.yml` to set up the development environment for feature work.
27+
The workflow will self-configure to create a build configuration file at `.github/actions/daily-progress/build-steps/action.yml` to set up the development environment for feature work.
3828

3929
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
4030

docs/daily-qa.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The [daily Adhoc QA workflow](../workflows/daily-qa.md?plain=1) will perform adh
1111
gh extension install github/gh-aw
1212

1313
# Add the Daily QA workflow to your repository
14-
gh aw add githubnext/agentics/daily-qa
14+
gh aw add-wizard githubnext/agentics/daily-qa
1515
```
1616

1717
This walks you through adding the workflow to your repository.
@@ -22,17 +22,9 @@ You can start a run of this workflow immediately by running:
2222
gh aw run daily-qa
2323
```
2424

25-
**Mandatory Checklist**
26-
27-
* [ ] I understand that, by default, the agentic portion of this workflow will generate and run bash commands in the confine of the GitHub Actions VM, with network access.
28-
29-
* [ ] If in a fork, enable GitHub Actions and Issues in the fork settings
30-
3125
## Configuration
3226

33-
This workflow requires no configuration and works out of the box. You can use local configuration to specify QA tasks, testing scenarios, reporting format, and frequency. Local configuration can be done in `.github/workflows/agentics/daily-qa.config.md`.
34-
35-
27+
This workflow requires no configuration and works out of the box. You can edit it to specify QA tasks, testing scenarios, reporting format, and frequency.
3628

3729
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
3830

docs/daily-repo-status.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The [daily repo status workflow](../workflows/daily-repo-status.md?plain=1) will
1111
gh extension install github/gh-aw
1212

1313
# Add the Daily Repo Status workflow to your repository
14-
gh aw add githubnext/agentics/daily-repo-status
14+
gh aw add-wizard githubnext/agentics/daily-repo-status
1515
```
1616

1717
This walks you through adding the workflow to your repository.

docs/daily-test-improver.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The [daily test coverage improver workflow](../workflows/daily-test-improver.md?
1111
gh extension install github/gh-aw
1212

1313
# Add the Daily Test Coverage Improver workflow to your repository
14-
gh aw add githubnext/agentics/daily-test-improver
14+
gh aw add-wizard githubnext/agentics/daily-test-improver
1515
```
1616

1717
This walks you through adding the workflow to your repository.
@@ -22,20 +22,12 @@ You can start a run of this workflow immediately by running:
2222
gh aw run daily-test-improver
2323
```
2424

25-
**Mandatory Checklist**
26-
27-
* [ ] I understand that, by default, the agentic portion of this workflow will generate and run bash commands in the confine of the GitHub Actions VM, with network access.
28-
29-
* [ ] I will review all pull requests very carefully, and carefully monitor the repository.
30-
3125
## Configuration
3226

3327
1. The first run of the workflow will produce a pull request with inferred action pre-steps that need approval.
3428

3529
2. The first run of the workflow will also create an issue in the repository with a plan for improving test coverage. You can comment on this issue to provide feedback or adjustments to the plan. Comments will not be picked up until the next run.
3630

37-
3. Use local configuration or comment on the plan to specify test generation strategies, high-priority areas and coverage targets. Local configuration can be done in `.github/workflows/agentics/daily-test-improver.config.md`.
38-
3931
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
4032

4133
## What it reads from GitHub

docs/issue-triage.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The [issue triage workflow](../workflows/issue-triage.md?plain=1) will when issu
1111
gh extension install github/gh-aw
1212

1313
# Add the Issue Triage workflow to your repository
14-
gh aw add githubnext/agentics/issue-triage
14+
gh aw add-wizard githubnext/agentics/issue-triage
1515
```
1616

1717
This walks you through adding the workflow to your repository.
@@ -20,15 +20,9 @@ You must also [choose a coding agent](https://github.github.com/gh-aw/reference/
2020

2121
You can't start a run of this workflow directly as it is triggered in the context of an issue.
2222

23-
**Mandatory Checklist**
24-
25-
* [ ] If in a fork, enable GitHub Actions and Issues in the fork settings
26-
2723
## Configuration
2824

29-
This workflow requires no configuration and works out of the box. You can use local configuration to customize triage criteria, labeling logic, customize issue categorization, modify automated responses. Local configuration can be done in `.github/workflows/agentics/issue-triage.config.md`.
30-
31-
2. Add MCPs to integrate with project management tools
25+
This workflow requires no configuration and works out of the box. You can edit it to customize triage criteria, labeling logic, customize issue categorization, modify automated responses.
3226

3327
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
3428

0 commit comments

Comments
 (0)