Skip to content

Commit 7e3ca2a

Browse files
authored
feat: add event provisioning examples and guidelines for workshop assets (#1624)
1 parent 0ec5697 commit 7e3ca2a

6 files changed

Lines changed: 78 additions & 2 deletions

File tree

.github/workflows/guidelines.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ Use these rules across workshop authoring/editing workflows to keep the tutorial
2727
- Keep command-heavy content narrow, purposeful, and optional when possible.
2828
- When terminal use is unavoidable, point learners to Codespaces as a low-friction bridge.
2929

30+
## Event provisioning surfaces
31+
32+
- Some workshop content is intentionally reused in provisioned event environments such as an org profile README and a learner-repository Codespaces launcher.
33+
- The maintained example assets live in `workshop/examples/event-provisioning/` and represent downstream copies, not primary authored content.
34+
- When you change workshop onboarding language that should also appear in those provisioned surfaces, update the marked source blocks in `workshop/00-welcome.md` and keep the examples in sync.
35+
- For provisioned learner repositories, prefer a Codespaces launcher entry point that starts at Step 4 or Step 5 because org invite, repository creation, and Codespace creation are already complete.
36+
3037
## Positioning agentic workflows as an Actions-compatible superset
3138

3239
- Present agentic workflows as a **smooth transition from classic GitHub Actions**, not a replacement that forces learners to start over.
@@ -197,7 +204,7 @@ This rule does not override clearly superior choices for all learners. It is a t
197204

198205
## Consistency check
199206

200-
Before finalizing workshop edits, quickly confirm that early steps remain UI-first, do not require `gh` before it is truly needed, and do not reference Node.js as a prerequisite.
207+
Before finalizing workshop edits, quickly confirm that early steps remain UI-first, do not require `gh` before it is truly needed, do not reference Node.js as a prerequisite, and keep any event-provisioning examples synchronized with the marked workshop source content.
201208

202209
## Activity numbering for a sortable adventure graph
203210

AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ automated tooling (author review, student simulation, order checks) under `.gith
1616
README.md # Workshop landing page (GitHub Skills style)
1717
AGENTS.md # This file — tips for AI agents
1818
workshop/ # Step-by-step workshop content (00-welcome.md … 16-connect-data-source.md)
19+
examples/event-provisioning/ # Example assets for provisioned org README and learner-repo Codespaces launchers
1920
.github/
2021
workflows/ # Agentic workflow definition files (*.md) and compiled lock files (*.lock.yml)
2122
skills/ # Copilot skill definitions for agentic-workflows and agentic-workflow-designer
@@ -66,13 +67,17 @@ The following rules are **disabled** in `.markdownlint-cli2.yaml` — do not add
6667

6768
**Never configure Codespace badges or `devcontainer.json` to open from this (`gh-aw-workshop`) repository.** The workshop repository itself is not a suitable Codespace base — learners work in their own practice repositories, not a clone of this one. Any Codespace badge or devcontainer setup must point to the learner's own repository.
6869

70+
The checked-in examples under `workshop/examples/event-provisioning/` are exceptions for template authoring only. They exist so event provisioning systems can copy a launcher into each learner's own repository; do not treat them as launchers for this repository itself.
71+
6972
## Working with workshop content
7073

7174
- Workshop steps are numbered files in `workshop/` (e.g., `07-your-first-workflow.md`).
7275
- Images referenced in workshop steps live in `workshop/images/`.
7376
- Keep `workshop/README.md` in sync whenever you add or rename a step.
7477
- Run the markdown linter before committing any workshop step edits.
7578
- When adding a new step, follow the existing file naming pattern and update the curriculum table in both `workshop/README.md` and `workshop/00-welcome.md`.
79+
- When editing shared intro or onboarding copy that may be reused outside the workshop pages, preserve and update the HTML reuse markers in `workshop/00-welcome.md`.
80+
- Treat `workshop/examples/event-provisioning/` as maintained examples. Keep the org-profile README and devcontainer launcher aligned with the corresponding marked source content in `workshop/00-welcome.md`.
7681

7782
## Working with agentic workflow files
7883

workshop/00-welcome.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
# Welcome — What We'll Build
66

7-
By the end of this workshop, a real AI agent will create an issue with a summary of the activity in your repostiory over the latest 24h, every day, without you writing shell-script workflow code.
7+
<!-- reuse:event-org-readme-intro:start -->
8+
By the end of this workshop, a real AI agent will create an issue with a summary of the activity in your repository over the latest 24h, every day, without you writing shell-script workflow code.
9+
<!-- reuse:event-org-readme-intro:end -->
810

911
![Sample daily repository status report generated by the finished workflow](images/00-daily-repo-status-output.svg)
1012

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Event Provisioning Examples
2+
3+
This folder contains example assets for workshop events that pre-provision a GitHub organization, learner repositories, and Codespaces.
4+
5+
Use these files as source material for the provisioned environment:
6+
7+
- [org-profile-README.md](org-profile-README.md) is an example org welcome README for `.github-private/profile/README.md`.
8+
- [devcontainer.json](devcontainer.json) is an example provisioned-repo Codespaces launcher for `.devcontainer/devcontainer.json`.
9+
10+
The reusable source content in the workshop pages is marked with HTML comments:
11+
12+
- `<!-- reuse:event-org-readme-intro:start -->` ... `<!-- reuse:event-org-readme-intro:end -->` in [00-welcome.md](../../00-welcome.md)
13+
- `<!-- reuse:event-org-readme-what-youll-do:start -->` ... `<!-- reuse:event-org-readme-what-youll-do:end -->` in [00-welcome.md](../../00-welcome.md)
14+
- `<!-- reuse:event-provisioned-start:start -->` ... `<!-- reuse:event-provisioned-start:end -->` in [00-welcome.md](../../00-welcome.md)
15+
16+
Those markers make it clear which workshop prose is safe to mirror into event-specific surfaces without reauthoring it from scratch.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "gh-aw workshop launcher: provisioned codespaces terminal",
3+
"image": "mcr.microsoft.com/devcontainers/base:ubuntu-24.04",
4+
"features": {
5+
"ghcr.io/devcontainers/features/github-cli:1": {}
6+
},
7+
"customizations": {
8+
"vscode": {
9+
"extensions": [
10+
"GitHub.copilot",
11+
"GitHub.copilot-chat"
12+
]
13+
}
14+
},
15+
"postCreateCommand": "bash -lc 'gh extension install github/gh-copilot --force && gh extension install github/gh-aw --force'",
16+
"postAttachCommand": "bash -lc 'url=https://github.github.com/gh-aw/workshop/#j=codespaces-terminal&s=foundation&t=04-github-actions-intro; printf \"\\nWorkshop URL: %s\\n\\n\" \"$url\"; if command -v xdg-open >/dev/null 2>&1; then xdg-open \"$url\" >/dev/null 2>&1 || true; fi; gh --version; gh aw --version'"
17+
}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# GitHub Agentic Workflows Workshop
2+
3+
Welcome to the provisioned workshop organization. Your event setup can create your practice repository, invite you to the org, and open a Codespace before you begin.
4+
5+
By the end of this workshop, a real AI agent will post a comment on one of your GitHub issues — automatically, every day, without you writing shell-script workflow code.
6+
7+
## What You'll Do
8+
9+
You'll build an [agentic workflow](https://github.github.com/gh-aw/introduction/overview/): a GitHub Action that uses AI to inspect your repository, decide what matters, and publish a useful status report on a schedule — practical enough to adapt for real teams.
10+
11+
What makes it different from regular GitHub Actions:
12+
13+
- It reasons about live repository state instead of only following a fixed script.
14+
- It turns signals into decisions — spotting stale pull requests or flagging CI trouble without hard-coding every branch.
15+
- It produces stakeholder-ready output automatically — a daily report people can actually use.
16+
17+
## Start Here
18+
19+
If your workshop organizer already created your repository and Codespace for you, start at one of these workshop entry points:
20+
21+
- [Step 4: GitHub Actions in 5 Minutes](https://github.github.com/gh-aw/workshop/#j=codespaces-terminal&s=foundation&t=04-github-actions-intro)
22+
- [Step 5: What Are Agentic Workflows?](https://github.github.com/gh-aw/workshop/#j=codespaces-terminal&s=foundation&t=05-agentic-workflows-intro)
23+
24+
Then continue with:
25+
26+
- [Step 6a: Install gh-aw — Codespace Terminal](https://github.github.com/gh-aw/workshop/#j=codespaces-terminal&s=foundation&t=06a-install-terminal)
27+
- [Step 7a: Write Your First Agentic Workflow — Terminal Path](https://github.github.com/gh-aw/workshop/#j=codespaces-terminal&s=foundation&t=07a-your-first-workflow-terminal)
28+
29+
If you want the full workshop from the beginning instead, start at [Step 0: Welcome](https://github.github.com/gh-aw/workshop/#j=codespaces-terminal&s=foundation&t=00-welcome).

0 commit comments

Comments
 (0)