Skip to content

Commit 7ce0449

Browse files
authored
fix(05): split agentic-workflows-intro to reduce cognitive load (#1787)
1 parent a017cef commit 7ce0449

3 files changed

Lines changed: 225 additions & 202 deletions

File tree

workshop/05-agentic-workflows-intro.md

Lines changed: 3 additions & 202 deletions
Original file line numberDiff line numberDiff line change
@@ -40,215 +40,16 @@ If you already write Actions YAML, the frontmatter stays the same (triggers, per
4040
- **What it produces:** A synthesized report or action the agent composes from live repository data — different every run based on what it finds.
4141
- **Why it exists:** Classic Actions handles deterministic CI/CD. Agentic workflows fill the gap for tasks that need judgment — or you can mix both in a single hybrid workflow.
4242

43-
## Classify these tasks
44-
45-
For each task below: classify it as **agentic workflow** or **standard Actions workflow**, check the box, then reveal the answer before the next task:
46-
47-
You just saw how a standard Actions workflow follows fixed steps. Agentic workflows replace those fixed steps with a plain-English task brief — use that contrast to classify the tasks below.
48-
49-
**Task A:** Run unit tests on every pull request, fail if any test exits non-zero, and upload coverage.
50-
51-
- [ ] I have classified Task A
52-
53-
<details>
54-
<summary>Check Task A answer</summary>
55-
56-
**Task A — Standard Actions workflow:** every run follows the same fixed steps: start the test job, fail on a non-zero exit code, and upload the coverage artifact. No judgment required.
57-
58-
</details>
59-
60-
**Task B:** Review newly opened issues each morning, group them by theme, flag the urgent ones, and post a short triage summary.
61-
62-
- [ ] I have classified Task B
63-
64-
<details>
65-
<summary>Check Task B answer</summary>
66-
67-
**Task B — Agentic workflow:** the agent has to inspect live repo context, group similar issues, and decide what looks urgent before it writes the summary.
68-
69-
</details>
70-
71-
## Reflection
72-
73-
Before you check the reflection item in the checkpoint below, write one sentence describing what you would want _your_ agentic workflow to do. Put it wherever you keep workshop notes: your editor, a scratch file, or a notes app. Example: summarize new issues and flag urgent ones. Focus on a task that needs judgment, not a test or deploy script. You'll use this idea in later.
74-
75-
## What the agent decided
76-
77-
A scheduled agentic workflow generates a report like this:
78-
79-
```markdown
80-
## Daily Repository Status — July 12
81-
82-
- ✅ CI health: 18 workflows succeeded, 1 failed (`docs-link-check`)
83-
- 🔄 Pull requests: 7 open (2 need review, 1 stale > 14 days)
84-
- 🐛 Issues: 4 new, 3 closed, 2 high-priority still open
85-
- 🚀 Releases: No new tags in the last 24 hours
86-
87-
### Recommended next actions
88-
1. Re-run `docs-link-check` and update broken external URLs.
89-
2. Review PR #412 and PR #415 before noon.
90-
3. Triage high-priority issue #398 with the platform team.
91-
```
92-
93-
**Your turn:** Answer in your own words — _what did the agent decide on its own?_ Identify at least two lines where the agent made a judgment call rather than just reading a number.
94-
95-
## Check your understanding
96-
97-
Apply what you just saw — answer each question in your notes, then reveal.
98-
99-
Should the daily report run on a schedule or wait for manual dispatch? State which and why.
100-
101-
- [ ] I chose a trigger type and explained my reasoning
102-
103-
<details>
104-
<summary>Check your answer</summary>
105-
106-
A scheduled trigger runs automatically — appropriate for a daily report. `workflow_dispatch` requires a button click in the Actions tab.
107-
108-
- [ ] Schedule: runs automatically, no button click needed
109-
- [ ] `workflow_dispatch`: requires a manual click each run
110-
111-
</details>
112-
113-
How does the agent post the report if it always operates read-only?
114-
115-
- [ ] I explained how the agent writes output
116-
117-
<details>
118-
<summary>Check your answer</summary>
119-
120-
Agents always run read-only. Any writes — including posting the report — go through [safe outputs](https://github.github.com/gh-aw/reference/safe-outputs/) and guardrails.
121-
122-
- [ ] The agent itself is always read-only
123-
- [ ] Writes happen through safe outputs and guardrails
124-
125-
</details>
126-
127-
Write one sentence for the task brief — this becomes your brief in Step 7.
128-
129-
- [ ] I wrote my one-sentence brief
130-
- [ ] My brief describes a task that needs judgment, not fixed steps
131-
132-
## The two files
133-
134-
An agentic workflow has two files. Here is the `.md` source you write:
135-
136-
```markdown
137-
---
138-
on:
139-
schedule: daily
140-
permissions:
141-
issues: read
142-
---
143-
144-
Review all open issues, summarize the key themes, and post a short digest as a new issue.
145-
```
146-
147-
> [!NOTE]
148-
> `schedule: daily` is fuzzy shorthand that `gh aw compile` converts into a standard Actions cron expression. You never write raw cron syntax in an agentic workflow `.md` file.
149-
150-
And here is the `.lock.yml` `gh aw compile` generates — what GitHub Actions actually runs:
151-
152-
```yaml
153-
# Auto-generated by gh aw compile. Do not edit by hand.
154-
name: Review open issues
155-
on:
156-
schedule:
157-
- cron: "0 8 * * *"
158-
permissions:
159-
issues: read
160-
```
161-
162-
Both files live in `.github/workflows/`. Look at them and answer: which part of the `.md` is the **task brief**, and which part tells GitHub Actions when to run?
163-
164-
## Concept check — before you continue
165-
166-
Before you reveal the answers below, write a one-sentence definition for each term:
167-
168-
- [ ] Agentic workflow
169-
- [ ] Lock file
170-
- [ ] Engine
171-
- [ ] `workflow_dispatch`
172-
173-
<details>
174-
<summary>Check your answers</summary>
175-
176-
| Term | Plain-language meaning |
177-
|---|---|
178-
| Agentic workflow | A GitHub Actions workflow that uses an AI model to reason and act |
179-
| [Lock file](https://github.github.com/gh-aw/reference/glossary/#workflow-lock-file-lockyml) | The compiled YAML that GitHub Actions actually runs |
180-
| [Engine](https://github.github.com/gh-aw/reference/engines/) | The AI model provider (for example, GitHub Copilot) used by the workflow |
181-
| `workflow_dispatch` | A manual trigger — you start the run by clicking a button in the Actions tab |
182-
183-
Confirm each:
184-
185-
- [ ] Lock file: compiled, not hand-edited
186-
- [ ] Engine: AI model provider
187-
- [ ] `workflow_dispatch`: manual trigger from Actions
188-
- [ ] Agentic workflow: AI reasoning loop
189-
190-
</details>
191-
192-
If you had to look up more than one term, take a moment to review that section before continuing.
193-
194-
## Classify more tasks
195-
196-
**Task C:** Each Friday, scan all open issues and pull requests, summarize recent activity by contributor, and post a weekly team progress digest.
197-
198-
- [ ] I have classified Task C
199-
200-
<details>
201-
<summary>Check Task C answer</summary>
202-
203-
**Task C — Agentic workflow:** the agent has to read contributor activity across issues and pull requests, decide what counts as meaningful progress, and compose a digest that differs every week.
204-
205-
</details>
206-
207-
**Task D:** On every pull request, run ESLint (fail on errors), then have an AI read the diff and post a summary comment.
208-
209-
- [ ] I have classified Task D
210-
211-
<details>
212-
<summary>Check Task D answer</summary>
213-
214-
**Task D — Agentic (hybrid) workflow:** ESLint is deterministic — same result every run. The AI summary requires judgment: reading the diff and deciding how to describe the change. Combining fixed and AI steps makes a workflow agentic.
215-
216-
- [ ] The ESLint step produces the same pass-or-fail result every run
217-
- [ ] The AI step produces different output based on what it reads in the diff
218-
- [ ] A workflow mixing deterministic and AI steps is still agentic overall
219-
220-
</details>
221-
222-
## Self-check
223-
224-
What makes a workflow agentic rather than standard? Write your answer in your notes.
225-
226-
- [ ] I wrote my self-check answer in my notes
227-
228-
<details>
229-
<summary>Show model answer</summary>
230-
231-
A workflow is agentic when an AI agent makes judgment calls — reading context, deciding what matters, and producing output that differs each run. Standard workflows follow fixed steps.
232-
233-
Does your answer include:
234-
- [ ] AI making judgment calls on live context
235-
- [ ] Output that varies each run
236-
- [ ] Contrast with standard fixed-step workflows
237-
238-
</details>
239-
24043
> [!TIP]
241-
> If this still feels fuzzy, Step 7 makes the distinction concrete. Return here after Step 7.
44+
> Want to go deeper? [Side Quest: Agentic Workflows Deep Dive](side-quest-05-02-aw-deep-dive.md) covers exercises, example output, the two-file structure, and concept checks.
24245
24346
## ✅ Checkpoint
24447

245-
- [ ] I described what an agentic workflow is in one sentence
48+
- [ ] I can describe what an agentic workflow is in one sentence
24649
- [ ] I can explain one way an agentic workflow differs from a standard Actions workflow
247-
- [ ] I can point to the task brief and the trigger in the sample `.md` file
248-
- [ ] I can describe the difference between the `.md` source file and the compiled `.lock.yml`
50+
- [ ] I can identify the three parts: trigger → agent → safe output
24951

25052
<!-- journey: all -->
25153
**Next:** [Install the gh-aw CLI Extension](06-install-gh-aw.md)
25254
<!-- /journey -->
25355

254-

workshop/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ A hands-on workshop that takes you from zero to a fully automated, AI-powered wo
4141
## Optional Side Quests
4242

4343
- [Side Quest: Agentic Workflows for GitHub Actions Power Users](side-quest-05-01-actions-power-user.md) — one-page cheat sheet for what changes vs what stays the same in agentic workflows; branches from [Step 5](05-agentic-workflows-intro.md).
44+
- [Side Quest: Agentic Workflows Deep Dive](side-quest-05-02-aw-deep-dive.md) — classification exercises, example agent output, the two-file structure, and concept checks; branches from [Step 5](05-agentic-workflows-intro.md).
4445
- [Side Quest: Terminal Basics](side-quest-01-01-terminal-basics.md) — optional primer that branches from [Step 1](01-prerequisites.md).
4546
- [Side Quest: Environment Reference](side-quest-01-02-environment-reference.md) — glossary of workshop environments and tool terms with official docs links; branches from [Step 1](01-prerequisites.md).
4647
- [Side Quest: Install `gh-aw` Troubleshooting](side-quest-06-01-install-troubleshooting.md) — optional install troubleshooting reference that branches from [Step 6](06-install-gh-aw.md).

0 commit comments

Comments
 (0)