protector: add page (#5820)

2021-04-25 07:00:01 +02:00
parent 32e86137f2
commit 1a47a2612f
1 changed files with 16 additions and 0 deletions
--- a/pages/common/protector.md
+++ b/pages/common/protector.md
@@ -0,0 +1,16 @@
+# protector
+
+> Protect or unprotect branches on GitHub repositories.
+> More information: <https://github.com/jcgay/protector>.
+
+- 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}}`