README.md

Ruleset recipes

Starter rulesets are pre-baked to make it easy to get started with repository rules.

What is a ruleset?

A ruleset is a named list of rules that applies to a repository. You can create rulesets to control how people interact with selected branches and tags in a repository. You can control things like who can push commits to a particular branch or who can delete or rename a tag. For example, you could set up a ruleset for your repository's feature branch that requires signed commits and blocks force pushes for all users except repository administrators.

Get cooking

1. Grab a copy of this repo

• ⬆️ top click < > Code
• Pick your favorite way to clone, like GitHub CLI, or download the ZIP.

2. To get started, visit your favorite repository or organization you have admin access to.

• Head to ⚙️Settings > Rules > Rulesets
• Select New Ruleset > Import a ruleset
• Browse to your local clone of the ruleset-recipes you want to import
• Review the imported ruleset and save your changes!
• Success! 🎉

Video Example

Table of contents

Branch Rulesets

• Branch protection best practices
• Require Pull Requests and conventional commits
• Organization ruleset: One Rule to rule them all

Tag Rulesets

• Prevent Tag Deletions
• Organization ruleset: requiring semantic versioning and prevents deletion for all tags