github-samples / github-samples/pets-workshop

GitHub security workshop: Add a safe secret scanning and push protection lab

Open
#275 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

priority: P3
Dominant language
Python
Stars
80
Forks
161
Avg merge
31m
Merged PRs (30d)
1

Description

Goal

Let learners experience a blocked push and the secret alert workflow without creating or publishing a usable credential.

Scope

Use only a GitHub-documented, non-sensitive test pattern that is guaranteed to exercise push protection at the time the workshop is validated. The test value must be generated or copied during the exercise and must not be stored in the template history. Cover the blocked push, remediation, bypass governance, alert review, and cleanup.

Acceptance criteria

  • Learners enable or verify secret scanning and push protection using current settings guidance.
  • The exercise links to the authoritative source for an approved non-sensitive test pattern.
  • No token-like test value is committed to this template repository.
  • Learners attempt the demonstration on a disposable branch and observe a blocked push.
  • The exercise explains why inventing an arbitrary fake string may not match a supported pattern.
  • Learners remove the value and successfully push the cleaned commit.
  • Bypass reasons, delegated bypass, alert ownership, and auditability are explained without requiring a bypass.
  • A fallback path is provided when push protection cannot be enabled.
  • Final verification confirms no secret or test pattern remains in branch history.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the workshop template content in github-samples/pets-workshop and reviewing current GitHub documentation for secret scanning, push protection, approved test patterns, bypass governance, and alerts. Validate the exercise on a disposable branch, including the blocked push, cleanup, fallback path, and final history check; done means every acceptance criterion works without storing a usable credential.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation, security
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.