Skip to content

Commit

Permalink
docs: add Branches / delete-branch to README
Browse files Browse the repository at this point in the history
  • Loading branch information
YOU54F committed Nov 10, 2023
1 parent a6aa9f2 commit 6c97236
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions script/update-cli-usage-in-readme.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down

0 comments on commit 6c97236

Please sign in to comment.