From 6c972364c36a428b651d3c1afe5a35ac16223c84 Mon Sep 17 00:00:00 2001
From: Yousaf Nabi <yousaf@pactflow.io>
Date: Fri, 10 Nov 2023 17:57:06 +0000
Subject: [PATCH] docs: add Branches / delete-branch to README

---
 README.md                            | 32 ++++++++++++++++++++++++++++
 script/update-cli-usage-in-readme.rb |  1 +
 2 files changed, 33 insertions(+)

diff --git a/README.md b/README.md
index 664aaae..cc398d2 100644
--- a/README.md
+++ b/README.md
@@ -859,6 +859,38 @@ Options:
 
 Test the execution of a webhook
 
+### Branches
+
+#### delete-branch
+
+```
+Usage:
+  pact-broker delete-branch --branch=BRANCH -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
+
+Options:
+  -a, --pacticipant=PACTICIPANT
+              # The name of the pacticipant that the branch belongs to.
+      --branch=BRANCH
+              # The pacticipant branch name.
+      [--error-when-not-found], [--no-error-when-not-found]
+              # Raise an error if the branch that is to be deleted is not
+                found.
+              # Default: true
+  -b, --broker-base-url=BROKER_BASE_URL
+              # The base URL of the Pact Broker
+  -u, [--broker-username=BROKER_USERNAME]
+              # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]
+              # Pact Broker basic auth password
+  -k, [--broker-token=BROKER_TOKEN]
+              # Pact Broker bearer token
+  -v, [--verbose], [--no-verbose]
+              # Verbose output.
+              # Default: false
+```
+
+Deletes a pacticipant branch.
+
 ### Tags
 
 #### create-version-tag
diff --git a/script/update-cli-usage-in-readme.rb b/script/update-cli-usage-in-readme.rb
index b69b1c5..f074ef0 100755
--- a/script/update-cli-usage-in-readme.rb
+++ b/script/update-cli-usage-in-readme.rb
@@ -23,6 +23,7 @@
   [PactBroker::Client::CLI::Broker, "Matrix", %w[can-i-deploy can-i-merge]],
   [PactBroker::Client::CLI::Broker, "Pacticipants", %w[create-or-update-pacticipant describe-pacticipant list-pacticipants]],
   [PactBroker::Client::CLI::Broker, "Webhooks", %w[create-webhook create-or-update-webhook test-webhook]],
+  [PactBroker::Client::CLI::Broker, "Branches", %w[delete-branch]],
   [PactBroker::Client::CLI::Broker, "Tags", %w[create-version-tag]],
   [PactBroker::Client::CLI::Broker, "Versions", %w[describe-version create-or-update-version]],
   [PactBroker::Client::CLI::Broker, "Miscellaneous", %w[generate-uuid]]