Skip to content

Commit 6766f1b

Browse files
authored
Add guidelines for golden-ticket workshop surfaces and maintenance (#1835)
1 parent 7653bb2 commit 6766f1b

2 files changed

Lines changed: 30 additions & 10 deletions

File tree

.github/workflows/guidelines.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,18 @@ Use these rules across workshop authoring/editing workflows to keep the tutorial
3434
- When the task is to create, edit, debug, or upgrade an agentic workflow from a CCA surface, explicitly call out the `/agentic-workflows` skill in the prompt.
3535
- If a CCA-oriented step still requires separate terminal work (for example `gh aw init` or `gh aw compile`), clearly separate the terminal action from the Agents-tab prompt so learners know which surface to use for each action.
3636

37-
## Event provisioning surfaces
38-
39-
- Some workshop content is intentionally reused in provisioned event environments such as an org profile README and a learner-repository Codespaces launcher.
40-
- The maintained example assets live in `workshop/examples/event-provisioning/` and represent downstream copies, not primary authored content.
41-
- 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.
42-
- 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.
37+
## Golden-Ticket Workshop Surfaces
38+
39+
- The golden-ticket workshop is the fully preconfigured beginner path: Copilot, repository setup, and Codespaces bootstrapping are prepared ahead of time.
40+
- Some workshop content is intentionally reused in golden-ticket workshop surfaces such as an org profile README and a learner-repository Codespaces launcher.
41+
- The maintained golden-ticket workshop assets live on the `golden-ticket-workshop` branch under `.github/participant-template/` plus `.github/workflows/create-participants-repo.yml`. During org provisioning, that branch is copied into the provisioned org's `.github-private` repository.
42+
- When you change workshop onboarding language that should also appear in those golden-ticket surfaces, update the marked source blocks in `workshop/00-welcome.md` and have the responsible agent check whether the `golden-ticket-workshop` branch also needs a corresponding update.
43+
- When an agent edits onboarding, setup, Codespaces, or early navigation content on `main`, it should explicitly assess downstream impact on `golden-ticket-workshop` and either update the affected branch assets or state why no branch change is needed.
44+
- Treat `workshop/00-welcome.md` as the source only for intentionally shared workshop framing and onboarding copy, not for page structure.
45+
- Treat the golden-ticket participant `README.md` as a separate launcher artifact for the preconfigured beginner experience, not as a structural mirror of `workshop/00-welcome.md`.
46+
- Keep the ending call-to-action intentionally different: `workshop/00-welcome.md` should continue learners into the next workshop step, while the golden-ticket participant `README.md` should direct them into the precreated repository and Codespaces flow.
47+
- The participant template's `README.md`, `.devcontainer/devcontainer.json`, `.vscode/tasks.json`, `.vscode/settings.json`, and the provisioning workflow are standalone assets and must be reviewed and tested in the branch and `.github-private` context where they run.
48+
- For golden-ticket 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.
4349

4450
## Positioning agentic workflows as an Actions-compatible superset
4551

@@ -245,7 +251,7 @@ This rule does not override clearly superior choices for all learners. It is a t
245251

246252
## Consistency check
247253

248-
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.
254+
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 ensure the responsible agent has checked whether any intended org-provisioned event changes also require updates on the `golden-ticket-workshop` branch.
249255

250256
## Activity numbering for a sortable adventure graph
251257

AGENTS.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ 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
2019
.github/
2120
workflows/ # Agentic workflow definition files (*.md) and compiled lock files (*.lock.yml)
2221
skills/ # Copilot skill definitions for agentic-workflows and agentic-workflow-designer
@@ -67,7 +66,13 @@ The following rules are **disabled** in `.markdownlint-cli2.yaml` — do not add
6766

6867
**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.
6968

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.
69+
## Working with the Golden-Ticket Workshop
70+
71+
The golden-ticket workshop assets live on the `golden-ticket-workshop` branch, not on `main`. This is the fully preconfigured beginner workshop path: Copilot, repository setup, and Codespaces bootstrapping are prepared ahead of time.
72+
73+
During org provisioning, that branch is copied into the provisioned org's `.github-private` repository. From there, `.github/workflows/create-participants-repo.yml` and the `.github/participant-template/` files create and update participant repositories.
74+
75+
Do not treat those launchers as suitable for this repository itself.
7176

7277
## Working with workshop content
7378

@@ -77,7 +82,16 @@ The checked-in examples under `workshop/examples/event-provisioning/` are except
7782
- Run the markdown linter before committing any workshop step edits.
7883
- 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`.
7984
- 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`.
85+
86+
Golden-ticket workshop maintenance rules:
87+
88+
- When a workshop change should also affect the golden-ticket workshop experience, agents should check whether the `golden-ticket-workshop` branch needs a corresponding update and carry that update through when it is in scope.
89+
- `workshop/00-welcome.md` owns only shared workshop framing and onboarding copy that is intentionally reused.
90+
- The golden-ticket branch README is its own launcher artifact for the preconfigured beginner experience. Do not try to keep it structurally identical to `workshop/00-welcome.md`.
91+
- Keep the ending call-to-action intentionally different: `workshop/00-welcome.md` should continue into the next workshop step, while the golden-ticket README should direct learners into the precreated repository and Codespaces flow.
92+
- The participant template files, Codespaces bootstrap files, and provisioning workflow are standalone branch assets.
93+
- When an agent edits onboarding, setup, Codespaces, or early navigation content on `main`, it should explicitly assess downstream impact on `golden-ticket-workshop` and either update the affected branch assets or state why no branch change is needed.
94+
- Validate golden-ticket changes in the branch and `.github-private` context where they run.
8195

8296
## Working with agentic workflow files
8397

0 commit comments

Comments
 (0)