GitHub security workshop: Enforce security merge gates with rulesets

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

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the CodeQL/security-check exercise referenced in the issue and the generic CI ruleset lesson in the Actions workshop. Build the security-focused workshop flow around the default branch, required checks, bypass and plan behavior, then verify that a vulnerable pull request is blocked, remediation allows it, and cleanup removes or disables the ruleset.

Written by the indexing model from the issue text.

Description

priority: deferred

Goal

Teach learners to turn security scanning from advisory feedback into an enforceable pull-request policy.

Scope

Create a repository ruleset for the default branch that requires the tested security checks and prevents a vulnerable pull request from merging. Explain check naming, merge-base behavior, bypass governance, and plan-dependent alternatives.

Acceptance criteria

  • Learners create a ruleset targeting the default branch without locking themselves out of the workshop.
  • The ruleset requires the CodeQL/security check produced by earlier exercises.
  • A pull request containing the training finding is visibly blocked from merging.
  • After remediation and a fresh scan, the same pull request becomes eligible under the security gate.
  • The exercise explains required status checks, required code scanning results where available, bypass actors, and evaluate/disabled modes.
  • A repository-level fallback is documented for plans that lack an organization-level control.
  • Cleanup instructions remove or disable the lab ruleset after verification.
  • The exercise does not duplicate the generic CI ruleset lesson in the Actions workshop; it focuses specifically on security policy.
Dominant language
Python
Stars
80
Forks
161
Avg merge
31m
Merged PRs (30d)
1

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.

More from github-samples/pets-workshop

All issues in github-samples/pets-workshop

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.