diff --git a/pages/common/protector.md b/pages/common/protector.md new file mode 100644 index 0000000000..f5ecfddaf4 --- /dev/null +++ b/pages/common/protector.md @@ -0,0 +1,16 @@ +# protector + +> Protect or unprotect branches on GitHub repositories. +> More information: . + +- Protect branches of a GitHub repository (create branch protection rules): + +`protector {{branches_regex}} -repos {{organization/repository}}` + +- Use the dry run to see what would be protected (can also be used for freeing): + +`protector -dry-run {{branches_regex}} -repos {{organization/repository}}` + +- Free branches of a GitHub repository (delete branch protection rules): + +`protector -free {{branches_regex}} -repos {{organization/repository}}`