-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathREPOSITORY_SECURITY.html
More file actions
642 lines (625 loc) · 36.1 KB
/
Copy pathREPOSITORY_SECURITY.html
File metadata and controls
642 lines (625 loc) · 36.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="GIT Going with GitHub - A two-day accessible open source workshop by Community Access">
<title>Repository Security & Access Guidelines - GIT Going with GitHub</title>
<link rel="stylesheet" href="./styles/github-markdown.css">
<link rel="stylesheet" href="./styles/highlight.css">
<link rel="stylesheet" href="./styles/custom.css">
<style>
.markdown-body {
box-sizing: border-box;
min-width: 0;
max-width: 980px;
margin: 0;
padding: 45px;
}
.page-layout {
max-width: 1320px;
margin: 0 auto;
padding: 1rem 1rem 2rem;
display: grid;
grid-template-columns: minmax(240px, 300px) minmax(0, 1fr);
gap: 1.25rem;
align-items: start;
}
@media (max-width: 767px) {
.page-layout {
grid-template-columns: 1fr;
padding: 0.5rem 0.5rem 1rem;
}
.markdown-body {
padding: 15px;
}
}
</style>
</head>
<body>
<a class="skip-link" href="#main-content">Skip to main content</a>
<header class="site-header" role="banner">
<div class="site-header-inner">
<nav aria-label="Breadcrumb" class="breadcrumb">
<a href="./index.html">Home</a> <span aria-hidden="true">›</span> <span aria-current="page">Repository Security & Access Guidelines</span>
</nav>
<div class="header-actions">
<a href="https://github.com/Community-Access/git-going-with-github/wiki" class="wiki-link" target="_blank" rel="noopener noreferrer">
<svg aria-hidden="true" focusable="false" width="16" height="16" viewBox="0 0 16 16" fill="currentColor">
<path d="M1.75 1h8.5c.966 0 1.75.784 1.75 1.75v5.5A1.75 1.75 0 0 1 10.25 10H7.06l-2.573 2.573A1.458 1.458 0 0 1 2 11.543V10h-.25A1.75 1.75 0 0 1 0 8.25v-5.5C0 1.784.784 1 1.75 1ZM1.5 2.75v5.5c0 .138.112.25.25.25h1a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h3.5a.25.25 0 0 0 .25-.25v-5.5a.25.25 0 0 0-.25-.25h-8.5a.25.25 0 0 0-.25.25Zm13 2a.25.25 0 0 0-.25-.25h-.5a.75.75 0 0 1 0-1.5h.5c.966 0 1.75.784 1.75 1.75v5.5A1.75 1.75 0 0 1 14.25 12H14v1.543a1.457 1.457 0 0 1-2.487 1.03L9.22 12.28a.749.749 0 1 1 1.06-1.06l2.22 2.22v-2.19a.75.75 0 0 1 .75-.75h.25a.25.25 0 0 0 .25-.25v-5.5Z"/>
</svg>
Wiki
</a>
<form role="search" class="search-form" action="./search.html" method="get">
<label for="site-search" class="search-label">Search docs</label>
<input
type="search"
id="site-search"
class="search-input"
name="q"
placeholder="Search docs…"
autocomplete="off"
aria-label="Search documentation"
>
<button type="submit" class="search-button" aria-label="Submit search">
<svg aria-hidden="true" focusable="false" width="16" height="16" viewBox="0 0 16 16" fill="currentColor">
<path d="M10.68 11.74a6 6 0 0 1-7.922-8.982 6 6 0 0 1 8.982 7.922l3.04 3.04a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215ZM11.5 7a4.499 4.499 0 1 0-8.997 0A4.499 4.499 0 0 0 11.5 7Z"/>
</svg>
</button>
</form>
</div>
</div>
</header>
<div class="page-layout">
<aside class="guided-sidebar" aria-label="Guided reference">
<h2 class="guided-title">Guided Reference</h2>
<p class="guided-intro">Follow the learning order, then jump into challenge issue views, appendices, and support resources.</p>
<section class="guided-resume" aria-label="Resume learning">
<a id="resume-link" class="guided-resume-link" href="./index.html" hidden>Resume where you left off</a>
</section>
<nav class="guided-nav" aria-label="Workshop navigation">
<section class="guided-section">
<h3>Start Here</h3>
<ul>
<li><a href="./index.html">Workshop Home</a></li>
<li><a href="./docs/course-guide.html">Course Guide</a></li>
<li><a href="./docs/get-going.html">Get Going with GitHub</a></li>
<li><a href="./docs/CHALLENGES.html">Challenge Hub</a></li>
</ul>
</section>
<section class="guided-section">
<h3>Learning Order</h3>
<details>
<summary>Day 1 chapters</summary>
<ul>
<li><a href="./docs/00-pre-workshop-setup.html">Pre-Workshop Setup - GIT Going with GitHub</a></li>
<li><a href="./docs/01-choose-your-tools.html">Choose Your Adventure: A Tool Tour</a></li>
<li><a href="./docs/02-understanding-github.html">Understanding GitHub's Web Structure</a></li>
<li><a href="./docs/03-navigating-repositories.html">Navigating Repositories</a></li>
<li><a href="./docs/04-the-learning-room.html">The Learning Room: Your Personal Practice Repository</a></li>
<li><a href="./docs/05-working-with-issues.html">Working with Issues</a></li>
<li><a href="./docs/06-working-with-pull-requests.html">Working with Pull Requests</a></li>
<li><a href="./docs/07-merge-conflicts.html">Merge Conflicts</a></li>
<li><a href="./docs/08-open-source-culture.html">Culture, Etiquette, and Community Standards</a></li>
<li><a href="./docs/09-labels-milestones-projects.html">Labels, Milestones, and Projects</a></li>
<li><a href="./docs/10-notifications-and-day-1-close.html">Notifications</a></li>
</ul>
</details>
<details>
<summary>Day 2 chapters</summary>
<ul>
<li><a href="./docs/11-vscode-interface.html">VS Code: Interface and Setup</a></li>
<li><a href="./docs/12-vscode-accessibility.html">VS Code: Accessibility Deep Dive</a></li>
<li><a href="./docs/13-how-git-works.html">How Git Works: The Mental Model</a></li>
<li><a href="./docs/14-git-in-practice.html">Git & Source Control in VS Code</a></li>
<li><a href="./docs/15-code-review.html">Code Review: PRs, Diffs, and Constructive Feedback</a></li>
<li><a href="./docs/16-github-copilot.html">GitHub Copilot</a></li>
<li><a href="./docs/17-issue-templates.html">Issue Templates</a></li>
<li><a href="./docs/18-fork-and-contribute.html">Fork and Contribute: The Open Source Workflow</a></li>
<li><a href="./docs/19-accessibility-agents.html">Accessibility Agents</a></li>
<li><a href="./docs/20-build-your-agent.html">Capstone Project: Contribute an Impactful Agent</a></li>
<li><a href="./docs/21-github-accessibility-and-open-source.html">GitHub Accessibility and Open Source at Scale</a></li>
<li><a href="./docs/22-what-comes-next.html">What Comes Next: Your Developer Journey</a></li>
</ul>
</details>
</section>
<section class="guided-section">
<h3>Appendices</h3>
<details>
<summary>Reference library</summary>
<ul>
<li><a href="./docs/appendix-a-glossary.html">Appendix A: GitHub Concepts & Glossary</a></li>
<li><a href="./docs/appendix-b-screen-reader-cheatsheet.html">Appendix B: Screen Reader Cheat Sheet</a></li>
<li><a href="./docs/appendix-c-markdown-reference.html">Appendix C: Markdown and GitHub Flavored Markdown - Complete Guide</a></li>
<li><a href="./docs/appendix-d-git-authentication.html">Appendix D: Git Authentication</a></li>
<li><a href="./docs/appendix-e-advanced-git.html">Appendix E: Advanced Git Operations</a></li>
<li><a href="./docs/appendix-f-git-security.html">Appendix F: Git Security for Contributors</a></li>
<li><a href="./docs/appendix-g-vscode-reference.html">Appendix G: VS Code Accessibility Reference</a></li>
<li><a href="./docs/appendix-h-github-desktop.html">Appendix H: GitHub Desktop</a></li>
<li><a href="./docs/appendix-i-github-cli.html">Appendix I: GitHub CLI Reference</a></li>
<li><a href="./docs/appendix-j-cloud-editors.html">Appendix J: GitHub Codespaces</a></li>
<li><a href="./docs/appendix-k-copilot-reference.html">Appendix K: Copilot Reference</a></li>
<li><a href="./docs/appendix-l-agents-reference.html">Appendix L: Accessibility Agents Reference</a></li>
<li><a href="./docs/appendix-m-accessibility-standards.html">Appendix M: Accessibility Standards Reference</a></li>
<li><a href="./docs/appendix-n-advanced-search.html">Appendix N: GitHub Advanced Search</a></li>
<li><a href="./docs/appendix-o-branch-protection.html">Appendix O: Branch Protection Rules and Repository Rulesets</a></li>
<li><a href="./docs/appendix-p-security-features.html">Appendix P: GitHub Security Features</a></li>
<li><a href="./docs/appendix-q-actions-workflows.html">Appendix Q: GitHub Actions and Workflows</a></li>
<li><a href="./docs/appendix-r-projects-deep-dive.html">Appendix R: GitHub Projects Deep Dive</a></li>
<li><a href="./docs/appendix-s-releases-tags-insights.html">Appendix S: Releases, Tags, and Repository Insights</a></li>
<li><a href="./docs/appendix-t-community-and-social.html">Appendix T: Community and Social</a></li>
<li><a href="./docs/appendix-u-discussions-and-gists.html">Appendix U: Discussions and Gists</a></li>
<li><a href="./docs/appendix-v-github-mobile.html">Appendix V: GitHub Mobile</a></li>
<li><a href="./docs/appendix-w-github-pages.html">Appendix W: Publishing with GitHub Pages</a></li>
<li><a href="./docs/appendix-x-resources.html">Appendix X: Resources</a></li>
<li><a href="./docs/appendix-y-workshop-materials.html">Appendix Y: Accessing and Downloading Workshop Materials</a></li>
<li><a href="./docs/appendix-z-github-skills.html">Appendix Z: GitHub Skills - Complete Course Catalog</a></li>
<li><a href="./docs/appendix-aa-agent-installation-setup.html">Appendix AA: Agent Installation & Setup Across All Platforms</a></li>
<li><a href="./docs/appendix-ab-advanced-agent-patterns.html">Appendix AB: Advanced Agent Patterns & Skills</a></li>
<li><a href="./docs/appendix-ac-document-developer-tools.html">Appendix AC: Document & Developer Tool Agents</a></li>
</ul>
</details>
</section>
<section class="guided-section">
<h3>Challenge Lab</h3>
<ul>
<li><a href="./docs/CHALLENGES.html">Challenge Hub</a></li>
<li><a href="./work.html">Issue-Style Challenge Walkthrough</a></li>
<li><a href="./docs/17-issue-templates.html">Issue Template Deep Dive</a></li>
</ul>
</section>
<section class="guided-section">
<h3>External Resources</h3>
<ul>
<li><a href="https://lp.csedesigns.com/ggg/PODCASTS.html">Podcast Episodes <span class="guided-external">(external)</span></a></li>
<li><a href="https://lp.csedesigns.com/ggg/feed.xml">RSS Feed <span class="guided-external">(external)</span></a></li>
</ul>
</section>
<section class="guided-section">
<h3>Get Help</h3>
<ul>
<li><a href="https://github.com/Community-Access/support">Support Hub <span class="guided-external">(external)</span></a></li>
</ul>
</section>
</nav>
</aside>
<main id="main-content" class="markdown-body page-main">
<nav class="quick-jumps" aria-label="Quick jumps">
<h2 class="quick-jumps-title">Quick Jumps</h2>
<ul class="quick-jumps-list">
<li><a href="#course-content">Jump to course content</a></li><li><a href="#main-content">Jump to main content top</a></li><li><a href="#on-this-page">Jump to on-page sections</a></li><li><a href="./docs/CHALLENGES.html">Open challenge hub</a></li><li><a href="./work.html">Open issue-style challenge walkthrough</a></li>
</ul>
</nav>
<nav id="on-this-page" class="onpage-nav" aria-label="On this page">
<h2 class="onpage-title">On This Page</h2>
<ul class="onpage-list">
<li class="onpage-item"><a href="#overview">Overview</a></li>
<li class="onpage-item"><a href="#access-control">Access Control</a></li>
<li class="onpage-item onpage-sub"><a href="#curriculum-repository-git-going-with-github">Curriculum Repository (git-going-with-github)</a></li>
<li class="onpage-item onpage-sub"><a href="#student-repositories-created-by-github-classroom">Student Repositories (created by GitHub Classroom)</a></li>
<li class="onpage-item onpage-sub"><a href="#organization-membership">Organization Membership</a></li>
<li class="onpage-item"><a href="#branch-protection">Branch Protection</a></li>
<li class="onpage-item onpage-sub"><a href="#curriculum-repository-main-branch">Curriculum Repository (main branch)</a></li>
<li class="onpage-item onpage-sub"><a href="#student-repositories">Student Repositories</a></li>
<li class="onpage-item onpage-sub"><a href="#what-students-cannot-do">What Students Cannot Do</a></li>
<li class="onpage-item"><a href="#permission-model">Permission Model</a></li>
<li class="onpage-item onpage-sub"><a href="#least-privilege">Least Privilege</a></li>
<li class="onpage-item"><a href="#facilitator-access">Facilitator Access</a></li>
<li class="onpage-item onpage-sub"><a href="#required-access-level">Required Access Level</a></li>
<li class="onpage-item onpage-sub"><a href="#adding-a-facilitator">Adding a Facilitator</a></li>
<li class="onpage-item onpage-sub"><a href="#removing-a-facilitator-after-the-workshop">Removing a Facilitator After the Workshop</a></li>
<li class="onpage-item"><a href="#github-actions-security">GitHub Actions Security</a></li>
<li class="onpage-item onpage-sub"><a href="#workflows-in-student-repositories">Workflows in Student Repositories</a></li>
<li class="onpage-item onpage-sub"><a href="#curriculum-repository-workflows">Curriculum Repository Workflows</a></li>
<li class="onpage-item"><a href="#data-privacy">Data Privacy</a></li>
<li class="onpage-item onpage-sub"><a href="#what-data-is-stored">What Data Is Stored</a></li>
<li class="onpage-item onpage-sub"><a href="#what-data-is-not-stored">What Data Is NOT Stored</a></li>
<li class="onpage-item onpage-sub"><a href="#data-retention">Data Retention</a></li>
<li class="onpage-item"><a href="#safety-checks">Safety Checks</a></li>
<li class="onpage-item onpage-sub"><a href="#before-the-workshop">Before the Workshop</a></li>
<li class="onpage-item onpage-sub"><a href="#during-the-workshop">During the Workshop</a></li>
<li class="onpage-item"><a href="#rollback-amp-emergency">Rollback & Emergency</a></li>
<li class="onpage-item onpage-sub"><a href="#if-something-goes-wrong">If Something Goes Wrong</a></li>
<li class="onpage-item"><a href="#compliance-amp-audit">Compliance & Audit</a></li>
<li class="onpage-item onpage-sub"><a href="#what-is-logged">What Is Logged</a></li>
<li class="onpage-item onpage-sub"><a href="#audit-priorities">Audit Priorities</a></li>
<li class="onpage-item"><a href="#contact-amp-support">Contact & Support</a></li>
<li class="onpage-item"><a href="#authoritative-sources">Authoritative Sources</a></li>
<li class="onpage-item onpage-sub"><a href="#section-level-source-map">Section-Level Source Map</a></li>
</ul>
</nav>
<div id="course-content"><h1 id="repository-security-amp-access-guidelines">Repository Security & Access Guidelines</h1>
<h2 id="overview">Overview</h2>
<p>This repository hosts the curriculum and facilitator materials for the Git Going with GitHub workshop. Student work happens in <strong>individual private repositories</strong> created by GitHub Classroom, not in this repository. This document covers the security model for both the curriculum repository and the student repositories.</p>
<h2 id="access-control">Access Control</h2>
<h3 id="curriculum-repository-git-going-with-github">Curriculum Repository (git-going-with-github)</h3>
<table>
<thead>
<tr>
<th scope="col">Role</th>
<th scope="col">Repository</th>
<th scope="col">Issues</th>
<th scope="col">PRs</th>
<th scope="col">Settings</th>
</tr>
</thead>
<tbody><tr>
<td>Facilitators</td>
<td>Full access</td>
<td>Full access</td>
<td>Review and merge</td>
<td>Admin</td>
</tr>
<tr>
<td>Contributors</td>
<td>Read</td>
<td>Create and comment</td>
<td>Create</td>
<td>None</td>
</tr>
<tr>
<td>Public</td>
<td>Read</td>
<td>View</td>
<td>View</td>
<td>None</td>
</tr>
</tbody></table>
<p>This repository is public. It contains no secrets, student data, or sensitive configuration. All curriculum content is openly licensed.</p>
<h3 id="student-repositories-created-by-github-classroom">Student Repositories (created by GitHub Classroom)</h3>
<table>
<thead>
<tr>
<th scope="col">Role</th>
<th scope="col">Repository</th>
<th scope="col">Issues</th>
<th scope="col">PRs</th>
<th scope="col">Settings</th>
</tr>
</thead>
<tbody><tr>
<td>Student (owner)</td>
<td>Read/Write</td>
<td>Full access</td>
<td>Create and merge</td>
<td>Limited (no Actions config)</td>
</tr>
<tr>
<td>Facilitators</td>
<td>Full access via Classroom</td>
<td>Full access</td>
<td>Review and comment</td>
<td>Admin</td>
</tr>
<tr>
<td>Other students</td>
<td>No access</td>
<td>No access</td>
<td>No access</td>
<td>No access</td>
</tr>
</tbody></table>
<p>Student repositories are <strong>private by default</strong>. Each student can only see their own repo. Facilitators see all student repos through the GitHub Classroom dashboard.</p>
<h3 id="organization-membership">Organization Membership</h3>
<p>Students do <strong>not</strong> need to be members of the Community-Access organization. GitHub Classroom handles all access automatically when a student accepts an assignment invite link. The student is granted access to their individual repo without any org-level permissions.</p>
<p>Facilitators <strong>do</strong> need organization-level access to manage the classroom. See the Facilitator Access section below.</p>
<h2 id="branch-protection">Branch Protection</h2>
<h3 id="curriculum-repository-main-branch">Curriculum Repository (main branch)</h3>
<p><strong>Protection Rules:</strong></p>
<ul>
<li>Require pull request reviews: Yes (1 approval minimum)</li>
<li>Require status checks to pass: Yes (GitHub Actions validation)</li>
<li>Require branches to be up to date: No (to avoid unnecessary merge conflicts)</li>
<li>Allow auto-merge: No (manual merge only for safety)</li>
<li>Allow force pushes: No (protect history)</li>
<li>Allow deletions: No (protect branch)</li>
</ul>
<h3 id="student-repositories">Student Repositories</h3>
<p>Student repos are created from the <code>learning-room-template</code>. Branch protection in student repos is intentionally minimal:</p>
<ul>
<li>Students can create branches freely (required for challenges)</li>
<li>Students can merge their own PRs (required for the learning flow)</li>
<li>No force push protection (students are learning; mistakes are part of the process)</li>
<li>GitHub Actions workflows run with read/write permissions (required for Gandalf and the Progression Bot)</li>
</ul>
<h3 id="what-students-cannot-do">What Students Cannot Do</h3>
<p>Even within their own repo, students cannot:</p>
<ul>
<li>Access GitHub Actions secrets at the organization level</li>
<li>Modify workflow files that run with elevated permissions</li>
<li>Access other students' repositories</li>
<li>View the classroom admin settings</li>
</ul>
<h2 id="permission-model">Permission Model</h2>
<h3 id="least-privilege">Least Privilege</h3>
<p>The GitHub Classroom model enforces least privilege by design:</p>
<ul>
<li>Students are <strong>not</strong> organization members</li>
<li>Students have <strong>no</strong> access to the curriculum repository's settings</li>
<li>Students have <strong>no</strong> access to other students' repos</li>
<li>Students have <strong>no</strong> access to CI/CD secrets or org-level configuration</li>
<li>Students <strong>can</strong> create branches, issues, and PRs in their own repo</li>
<li>Students <strong>can</strong> push to any branch in their own repo</li>
<li>Students <strong>can</strong> merge PRs in their own repo (with autograder checks reporting status)</li>
</ul>
<h2 id="facilitator-access">Facilitator Access</h2>
<h3 id="required-access-level">Required Access Level</h3>
<p>Facilitators must be <strong>Owners</strong> or <strong>Admins</strong> of the Community-Access organization to:</p>
<ul>
<li>Create and manage GitHub Classroom assignments</li>
<li>View all student repositories through the classroom dashboard</li>
<li>Comment on student PRs via the feedback pull request</li>
<li>Monitor autograding results</li>
<li>Troubleshoot workflow failures in student repos</li>
</ul>
<h3 id="adding-a-facilitator">Adding a Facilitator</h3>
<pre><code class="hljs language-bash"><span class="hljs-comment"># Add a facilitator as an org admin</span>
gh api /orgs/Community-Access/memberships/USERNAME -X PUT -f role=admin
<span class="hljs-comment"># Verify the role</span>
gh api /orgs/Community-Access/memberships/USERNAME --jq .role
<span class="hljs-comment"># Expected output: "admin"</span></code></pre>
<h3 id="removing-a-facilitator-after-the-workshop">Removing a Facilitator After the Workshop</h3>
<pre><code class="hljs language-bash"><span class="hljs-comment"># Downgrade to member (retains read access) or remove entirely</span>
gh api /orgs/Community-Access/memberships/USERNAME -X DELETE</code></pre>
<h2 id="github-actions-security">GitHub Actions Security</h2>
<h3 id="workflows-in-student-repositories">Workflows in Student Repositories</h3>
<p>The template repository includes these workflows, which are copied into every student repo:</p>
<table>
<thead>
<tr>
<th scope="col">Workflow</th>
<th scope="col">Trigger</th>
<th scope="col">Permissions</th>
<th scope="col">What It Does</th>
</tr>
</thead>
<tbody><tr>
<td><code>pr-validation-bot.yml</code></td>
<td>PR opened/updated</td>
<td>Read/Write</td>
<td>Gandalf validates PR structure and posts feedback</td>
</tr>
<tr>
<td><code>student-progression.yml</code></td>
<td>Issue closed</td>
<td>Read/Write</td>
<td>Creates the next challenge issue</td>
</tr>
<tr>
<td><code>autograder-conflicts.yml</code></td>
<td>Push</td>
<td>Read</td>
<td>Checks for conflict markers</td>
</tr>
<tr>
<td><code>autograder-local-commit.yml</code></td>
<td>Push</td>
<td>Read</td>
<td>Verifies local commit evidence</td>
</tr>
<tr>
<td><code>autograder-template.yml</code></td>
<td>Push</td>
<td>Read</td>
<td>Validates YAML template</td>
</tr>
<tr>
<td><code>autograder-capstone.yml</code></td>
<td>Push</td>
<td>Read</td>
<td>Validates agent file structure</td>
</tr>
</tbody></table>
<p><strong>Safety guarantees:</strong></p>
<ul>
<li>Workflows use only <code>GITHUB_TOKEN</code> (scoped to the individual student repo)</li>
<li>No external API keys or webhook secrets are stored</li>
<li>Workflows cannot access other repositories or organization-level resources</li>
<li>Workflow code is visible to the student (transparency)</li>
</ul>
<h3 id="curriculum-repository-workflows">Curriculum Repository Workflows</h3>
<p>The curriculum repo uses standard CI workflows for building HTML/EPUB output. These workflows:</p>
<ul>
<li>Run on PRs to <code>main</code> only</li>
<li>Have read-only permissions</li>
<li>Do not deploy to production automatically</li>
<li>Cannot modify student repositories</li>
</ul>
<h2 id="data-privacy">Data Privacy</h2>
<h3 id="what-data-is-stored">What Data Is Stored</h3>
<p><strong>In the curriculum repository:</strong></p>
<ul>
<li>No student data. This repo contains only curriculum content and facilitator guides.</li>
</ul>
<p><strong>In the private student-success repository:</strong></p>
<ul>
<li>Private cohort operations data belongs in <code>Community-Access/git-going-student-success</code></li>
<li>This includes registration exports, facilitator notes, accommodation follow-up, grade exports, and student-success follow-up records</li>
<li>Do not store credentials, API keys, or tokens there; use an approved secret manager for secrets</li>
</ul>
<p><strong>In GitHub Classroom:</strong></p>
<ul>
<li>Student GitHub usernames (public information)</li>
<li>Roster data (identifier, optional name, optional email) -- visible only to classroom admins</li>
<li>Assignment acceptance timestamps</li>
<li>Autograding scores</li>
</ul>
<p><strong>In student repositories:</strong></p>
<ul>
<li>Commit history (who wrote what, when)</li>
<li>Issue and PR comments (visible only to the student and facilitators)</li>
<li>Branch names</li>
</ul>
<h3 id="what-data-is-not-stored">What Data Is NOT Stored</h3>
<ul>
<li>Real names (optional in roster; not required)</li>
<li>Home addresses</li>
<li>Phone numbers</li>
<li>Email addresses (only if added to roster by the facilitator)</li>
<li>Payment information</li>
<li>Health information beyond what students voluntarily disclose</li>
</ul>
<h3 id="data-retention">Data Retention</h3>
<p>Student repositories persist after the workshop unless explicitly deleted. Facilitators can:</p>
<ul>
<li>Archive the classroom (makes repos read-only; preserves them as portfolio pieces)</li>
<li>Delete student repos through the classroom settings</li>
<li>Export grades before archiving</li>
</ul>
<p>See <a href="classroom/teardown-checklist.html">teardown-checklist.md</a> for the complete post-workshop cleanup process. Preserve private student-success records in <code>Community-Access/git-going-student-success</code> before deleting local exports or archiving Classroom data.</p>
<h2 id="safety-checks">Safety Checks</h2>
<h3 id="before-the-workshop">Before the Workshop</h3>
<p><strong>Deployment verification:</strong> Complete the verification checklist in the <a href="classroom/README.html#step-6-verify-everything-works">Workshop Deployment Guide</a>. This confirms:</p>
<ul>
<li>Student repos are created correctly from the template</li>
<li>Gandalf responds to PRs within 60 seconds</li>
<li>The Progression Bot creates challenge issues on issue close</li>
<li>Autograding runs and reports results</li>
<li>The feedback PR is created by Classroom</li>
</ul>
<p><strong>Facilitator access:</strong> Confirm all facilitators can:</p>
<ul>
<li>View the classroom dashboard</li>
<li>Open student repos from the dashboard</li>
<li>Comment on student issues and PRs</li>
</ul>
<h3 id="during-the-workshop">During the Workshop</h3>
<p><strong>Monitoring:</strong></p>
<ul>
<li>GitHub status page: <a href="https://www.githubstatus.com/">https://www.githubstatus.com/</a></li>
<li>Classroom dashboard for student progress and autograding results</li>
<li>Student repos' Actions tabs for workflow failures</li>
</ul>
<p><strong>Incident Response:</strong></p>
<table>
<thead>
<tr>
<th scope="col">Incident</th>
<th scope="col">Response</th>
</tr>
</thead>
<tbody><tr>
<td>GitHub is down</td>
<td>Continue teaching fundamentals offline; resume when GitHub is back</td>
</tr>
<tr>
<td>Gandalf stops responding</td>
<td>Check Actions tab; facilitators post feedback manually until resolved</td>
</tr>
<tr>
<td>Autograding fails</td>
<td>Check workflow logs; use it as a teaching moment about CI/CD</td>
</tr>
<tr>
<td>Student cannot accept invite</td>
<td>Verify GitHub account exists and is signed in; check roster match</td>
</tr>
<tr>
<td>Progression Bot skips a challenge</td>
<td>Check Actions tab for errors; manually create the missed issue</td>
</tr>
</tbody></table>
<h2 id="rollback-amp-emergency">Rollback & Emergency</h2>
<h3 id="if-something-goes-wrong">If Something Goes Wrong</h3>
<p><strong>GitHub outage:</strong></p>
<ul>
<li>Monitor: <a href="https://www.githubstatus.com/">https://www.githubstatus.com/</a></li>
<li>Fallback: Continue teaching fundamentals offline</li>
<li>Recovery: Resume when GitHub is back; student repos persist through outages</li>
</ul>
<p><strong>Student accidentally deletes a workflow file:</strong></p>
<ul>
<li>Restore the file from the template repository</li>
<li>Commit directly to the student's <code>main</code> branch</li>
<li>The workflow resumes on the next trigger</li>
</ul>
<p><strong>Need to revert a student's work:</strong></p>
<ul>
<li>Use <code>git revert</code> (do not force push -- protect learning history)</li>
<li>Guide the student through the revert as a teaching moment</li>
</ul>
<p><strong>Student repo is corrupted:</strong></p>
<ul>
<li>Have the student accept the invite link again (Classroom creates a fresh repo if the original is deleted)</li>
<li>Or restore files manually from the template</li>
</ul>
<h2 id="compliance-amp-audit">Compliance & Audit</h2>
<h3 id="what-is-logged">What Is Logged</h3>
<p>GitHub automatically logs:</p>
<ul>
<li>All push events (who, what, when)</li>
<li>All PR activity (created, reviewed, merged)</li>
<li>All issue activity (created, commented, closed)</li>
<li>Workflow runs and results</li>
</ul>
<p>These logs are available in:</p>
<ul>
<li>Each repository's Actions tab (workflow history)</li>
<li>Organization settings > Audit log (admin actions)</li>
<li>GitHub Classroom dashboard (assignment and grading data)</li>
</ul>
<h3 id="audit-priorities">Audit Priorities</h3>
<ul>
<li>All curriculum changes go through PR review (enforced by branch protection)</li>
<li>No direct pushes to <code>main</code> in the curriculum repository</li>
<li>Student repos use automation only through <code>GITHUB_TOKEN</code> (no external credentials)</li>
<li>Facilitator access is scoped to the workshop duration and removed afterward</li>
</ul>
<h2 id="contact-amp-support">Contact & Support</h2>
<p><strong>GitHub Organization:</strong> <a href="https://github.com/Community-Access">https://github.com/Community-Access</a>
<strong>Curriculum Repository:</strong> <a href="https://github.com/Community-Access/git-going-with-github">https://github.com/Community-Access/git-going-with-github</a>
<strong>GitHub Classroom:</strong> <a href="https://classroom.github.com">https://classroom.github.com</a>
<strong>GitHub Status:</strong> <a href="https://www.githubstatus.com/">https://www.githubstatus.com/</a></p>
<h2 id="authoritative-sources">Authoritative Sources</h2>
<p>Use these official references when you need the current source of truth for facts in this chapter.</p>
<ul>
<li><a href="https://docs.github.com/en">GitHub Docs, home</a></li>
<li><a href="https://github.blog/changelog/">GitHub Changelog</a></li>
<li><a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a></li>
<li><a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a></li>
<li><a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
</ul>
<h3 id="section-level-source-map">Section-Level Source Map</h3>
<p>Use this map to verify facts for each major section in this file.</p>
<ul>
<li><strong>Overview:</strong> <a href="https://docs.github.com/en">GitHub Docs, home</a>, <a href="https://github.blog/changelog/">GitHub Changelog</a>, <a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a>, <a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a>, <a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
<li><strong>Access Control:</strong> <a href="https://docs.github.com/en">GitHub Docs, home</a>, <a href="https://github.blog/changelog/">GitHub Changelog</a>, <a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a>, <a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a>, <a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
<li><strong>Branch Protection:</strong> <a href="https://docs.github.com/en">GitHub Docs, home</a>, <a href="https://github.blog/changelog/">GitHub Changelog</a>, <a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a>, <a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a>, <a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
<li><strong>Permission Model:</strong> <a href="https://docs.github.com/en">GitHub Docs, home</a>, <a href="https://github.blog/changelog/">GitHub Changelog</a>, <a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a>, <a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a>, <a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
<li><strong>Facilitator Access:</strong> <a href="https://docs.github.com/en">GitHub Docs, home</a>, <a href="https://github.blog/changelog/">GitHub Changelog</a>, <a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a>, <a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a>, <a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
<li><strong>GitHub Actions Security:</strong> <a href="https://docs.github.com/en">GitHub Docs, home</a>, <a href="https://github.blog/changelog/">GitHub Changelog</a>, <a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a>, <a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a>, <a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
<li><strong>Data Privacy:</strong> <a href="https://docs.github.com/en">GitHub Docs, home</a>, <a href="https://github.blog/changelog/">GitHub Changelog</a>, <a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a>, <a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a>, <a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
<li><strong>Safety Checks:</strong> <a href="https://docs.github.com/en">GitHub Docs, home</a>, <a href="https://github.blog/changelog/">GitHub Changelog</a>, <a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a>, <a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a>, <a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
<li><strong>Rollback & Emergency:</strong> <a href="https://docs.github.com/en">GitHub Docs, home</a>, <a href="https://github.blog/changelog/">GitHub Changelog</a>, <a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a>, <a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a>, <a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
<li><strong>Compliance & Audit:</strong> <a href="https://docs.github.com/en">GitHub Docs, home</a>, <a href="https://github.blog/changelog/">GitHub Changelog</a>, <a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a>, <a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a>, <a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
<li><strong>Contact & Support:</strong> <a href="https://docs.github.com/en">GitHub Docs, home</a>, <a href="https://github.blog/changelog/">GitHub Changelog</a>, <a href="https://docs.github.com/en/code-security/getting-started/github-security-features">GitHub security features</a>, <a href="https://docs.github.com/en/code-security/dependabot">Dependabot docs</a>, <a href="https://docs.github.com/en/code-security/secret-scanning/introduction/about-secret-scanning">Secret scanning docs</a></li>
</ul>
</div>
</main>
</div>
<footer role="contentinfo" class="site-footer">
<p><strong>GIT Going with GitHub</strong> - A workshop by <a href="https://community-access.org">Community Access</a></p>
<p><a href="https://github.com/community-access/git-going-with-github">View on GitHub</a> · <a href="https://community-access.org">community-access.org</a></p>
</footer>
<script>
(function() {
var key = 'gggLastVisitedPath';
var currentPath = window.location.pathname || '';
try {
if (currentPath) {
localStorage.setItem(key, currentPath);
}
} catch (e) {}
var resumeLink = document.getElementById('resume-link');
if (!resumeLink) return;
try {
var savedPath = localStorage.getItem(key);
if (savedPath && savedPath !== currentPath) {
resumeLink.hidden = false;
resumeLink.setAttribute('href', savedPath);
}
} catch (e) {}
})();
</script>
</body>
</html>