From 54d61fbf7ff94d7d824e6ce31f4d6af4fc73cdfc Mon Sep 17 00:00:00 2001 From: Ben Thorner Date: Wed, 27 Apr 2022 09:49:46 +0100 Subject: [PATCH] Minor changes in response to PR comments --- docs/versioning.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/versioning.md b/docs/versioning.md index f7bfeee..440ea76 100644 --- a/docs/versioning.md +++ b/docs/versioning.md @@ -2,15 +2,15 @@ Out of the box, the Pact Broker allows uploading of pact files with semver style versions (eg 2.0.1). For our usage, we wanted to be able to upload pact -files from various branches in addition the released versions so that our -branch builds of consumers can verify their pactfiles with the producers. +files from various branches in addition to the released versions so that our +branch builds of consumers can verify their pactfiles with the providers. Pact Broker allows us to [implement our own versioning scheme](https://github.com/bethesque/pact_broker/wiki/Configuration#version-parser) -by providing a custom version parser. We've [used -this](https://github.com/alphagov/govuk-pact-broker/blob/master/config.ru#L23-L50) +by providing a custom version parser. We've [used +this](https://github.com/alphagov/govuk-pact-broker/blob/main/config.ru#L23-L50) to extend the versioning scheme to allow branch builds to be uploaded as well. -In addition to numeric versions, our scheme allows for "master", and +In addition to numeric versions, our scheme allows for "main", and "branch-foo" versions to be uploaded. These will always be ordered after any -numeric versions, so the 'latest' pactfile from the pact brokers POV will +numeric versions, so the 'latest' pactfile from the Pact Broker's point of view will always be the highest numeric version.