Revert "chore: update release workflow to use new versioning scheme"

This reverts commit e2736e6.

.github/workflows/manual_release_package.yml

@@ -0,0 +1,38 @@
+name: Release Docker image with updated packaging
+
+on:
+  workflow_dispatch:
+    inputs:
+      release:
+        description: Release number
+        required: true
+        type: number
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - uses: ruby/setup-ruby@v1
+
+    - name: Prepare release
+      id: prepare-release
+      run: script/workflows/prepare-release.sh
+      env:
+        RELEASE: ${{ inputs.release }}
+
+    - name: Commit and push version and changelog
+      uses: EndBug/add-and-commit@v4
+      with:
+        add: CHANGELOG.md
+        author_name: Beth Skurrie via Github Action
+        author_email: [email protected]
+        message: 'chore(release): version ${{ steps.prepare-release.outputs.tag }}'
+        tag: '${{ steps.prepare-release.outputs.tag }}'
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release_image.yml

@@ -15,20 +15,7 @@ on:
           - major
           - minor
           - patch
-      # Sets the first part of the Docker tag - this will update the VERSION file
-      version:
-        description: "Custom version, requires increment to be set"
-        required: false
-      tag:
-        description: "Custom Docker image tag (note - this won't update the VERSION file and is for non-prod releases only)"
-        required: false
-      push_to_latest:
-        description: 'Should push to latest'
-        type: boolean
-        default: true
-      docker_repository:
-        description: The Docker repository to which the image should be published
-        default: pactfoundation
+
 jobs:
   release:
     runs-on: ubuntu-latest
@@ -48,9 +35,5 @@ jobs:
         env:
           DOCKER_HUB_USERNAME: ${{ secrets.DOCKER_HUB_USERNAME }}
           DOCKER_HUB_TOKEN: ${{ secrets.DOCKER_HUB_TOKEN }}
-          DOCKER_REPOSITORY: ${{ github.event.inputs.docker_repository }}
-          TAG: ${{ github.event.inputs.tag }}
-          VERSION: ${{ github.event.inputs.version }}
-          # populate INCREMENT from workflow_dispatch or repository_dispatch
-          INCREMENT: ${{ github.event.client_payload.increment }}${{ github.event.inputs.increment }}
-          PUSH_TO_LATEST: ${{ github.event.inputs.push_to_latest }}
+          CUSTOM_TAG: ${{ github.event.client_payload.tag }}
+          INCREMENT: ${{ github.event.inputs.increment }}

.github/workflows/update-and-prepare-release.yml

@@ -0,0 +1,52 @@
+# TODO abort if there are no changes to the Gemfile.
+
+name: Update gems and prepare to release Docker image
+
+on:
+  repository_dispatch:
+    types:
+      - gem-released-disabled
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - uses: ruby/setup-ruby@v1
+
+    - id: update
+      run: script/workflows/update.sh
+      env:
+        RELEASED_GEM_NAME: ${{ github.event.client_payload.name }}
+        RELEASED_GEM_VERSION: ${{ github.event.client_payload.version }}
+
+    - name: Commit and push gem file changes
+      uses: EndBug/add-and-commit@v4
+      with:
+        add: Gemfile.lock
+        author_name: Beth Skurrie via Github Action
+        author_email: [email protected]
+        message: 'feat(gems): ${{ steps.update.outputs.commit_message }}'
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - id: prepare-release
+      name: Update version and generate changelog
+      run: script/workflows/prepare-release.sh
+      env:
+        INCREMENT: ${{ github.event.client_payload.increment }}
+
+    - name: Commit and push version and changelog
+      uses: EndBug/add-and-commit@v4
+      with:
+        add: lib/pact/cli/version.rb Gemfile.lock CHANGELOG.md
+        author_name: Beth Skurrie via Github Action
+        author_email: [email protected]
+        message: 'chore(release): version ${{ steps.prepare-release.outputs.tag }}'
+        tag: '${{ steps.prepare-release.outputs.tag }}'
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/update-gems.yml

@@ -0,0 +1,41 @@
+# TODO abort if there are no changes to the Gemfile.
+
+name: Update gems
+
+on:
+  repository_dispatch:
+    types:
+      - gem-released
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - uses: ruby/setup-ruby@v1
+
+    - id: update
+      run: script/workflows/update.sh
+      env:
+        RELEASED_GEM_NAME: ${{ github.event.client_payload.name }}
+        RELEASED_GEM_VERSION: ${{ github.event.client_payload.version }}
+
+    - name: Commit and push gem file changes
+      uses: EndBug/add-and-commit@v4
+      with:
+        add: Gemfile.lock
+        author_name: Beth Skurrie via Github Action
+        author_email: [email protected]
+        message: 'feat(gems): ${{ steps.update.outputs.commit_message }}'
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Trigger release
+      uses: peter-evans/repository-dispatch@v1
+      with:
+        token: ${{ secrets.GHTOKENFORPACTCLIRELEASE }}
+        event-type: release-triggered

README.md

@@ -1,8 +1,6 @@
 # Pact CLI
 
-This tool provides an amalgamated CLI of all the Pact CLI tools available in the Pact Ruby implementation (publish and verify pacts, and interact with the Pact Broker). While it is functionally the same as the [pact-ruby-standalone](https://github.com/pact-foundation/pact-ruby-standalone) it is packaged as a Docker container and a single top level entrypoint (`pact`). You can pull the `pactfoundation/pact-cli` image from [Dockerhub](https://hub.docker.com/r/pactfoundation/pact-cli)
-
-> Note: On 23rd May 2023, the format of the docker tag changed from ending with the Pact Cli Gem version (`0.51.0.4`), where `.4` noted a change to the one of the packaged gems, to ending with the Pact Cli gem version (`0.52.0-pactcli0.52.0`). Read about the new versioning scheme [here](#versioning).
+This tool provides an amalgamated CLI of all the Pact CLI tools available in the Pact Ruby implementation (publish and verify pacts, and interact with the Pact Broker). While it is functionally the same as the [pact-ruby-standalone](https://github.com/pact-foundation/pact-ruby-standalone) it is packaged as a Docker container and a single top level entrypoint (`pact`).
 
 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/pact-foundation/pact-msw-adapter/graphs/commit-activity)
 
@@ -218,28 +216,6 @@ lib
 pact-cli.gemspec
 ```
 
-## Versioning
-
-The Docker image tag uses a semantic-like versioning scheme (Docker tags don't support the `+` symbol, so we cannot implement a strict semantic version). The format of the tag is `M.m.p-pactcli<pact_cli_version>` eg. `0.52.0-pactcli0.52.0`. The `M.m.p` (eg. `0.52.0`) is the semantic part of the tag number, while the `-pactcli<pact_cli_version>` suffix is purely informational.
-
-The major version will be bumped for:
-
-  * Major increments of the Pact Cli gem
-  * Major increments of the base image that contain backwards incompatible changes (eg. dropping support for Docker 19)
-  * Any other backwards incompatible changes made for any reason (eg. environment variable mappings, entrypoints, tasks, supported auth)
-
-The minor version will be bumped for:
-
-  * Minor increments of the Pact Cli gem
-  * Additional non-breaking functionality added to the Docker image
-
-The patch version will be bumped for:
-
-  * Patch increments of the Pact Cli gem
-  * Other fixes to the Docker image
-
-Until May 2023, the versioning scheme used the `M.m.p` from the Pact Cli gem, with an additional `RELEASE` number at the end (eg. `0.51.0.4`). This scheme was replace by the current scheme because it was unable to semantically convey changes made to the Docker image that were unrelated to a Pact Cli gem version change (eg. alpine upgrades).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/pact-foundation/pact-ruby-cli.

RELEASING.md

@@ -1,40 +1,5 @@
 # Releasing
 
-When one of the Pact gems is released, it sends a repository dispatch notification with event type `gem-released`, which triggers the `Update gems` Github Action that updates the gems and commits the changes. The `Release` workflow is then triggered by another repository dispatch action of type `release-triggered` which generates the release notes, builds and publishes the Docker image, and creates the git commits and tags.
+Manual releases are not generally necessary. When one of the Pact gems is released, it sends a repository dispatch notification with event type `gem-released`, which triggers the `Update gems` Github Action that updates the gems and commits the changes. The `Release` workflow is then triggered by another repository dispatch action of type `release-triggered` which generates the release notes, builds and publishes the Docker image, and creates the git commits and tags.
 
 If the packaging code needs to be updated, a manual release can be performed by running the `Release Docker image with updated packaging` workflow from the UI.
-
-# Releasing
-
-Please read the [versioning](/#versioning) section of the README file before continuing.
-
-The semantic version part of the tag is stored in the `VERSION` file at the root of the repository.
-
-> Manual releases are not generally necessary.
-
-## Automatic releases of the Docker image triggered by the release of one of the Pact gem
-
-When one of the Pact gems is released by the Github Action in its repository, the `repository_dispatch` action of the `pact-ruby-cli` repository will be invoked with the type `gem-released`, and the release details (name, version, increment).
-
-This causes the `update_gems.yml` workflow to be run. At the end of the workflow, it will trigger a release by invoking the `repository_dispatch` action with type `release-triggered`, passing in the increment.
-
-Note: sometimes bundler cannot find the newly released gem straight away, and the job needs to be re-run via the UI.
-
-### Manual releases of the Docker image triggered by the release of one of the Pact gem
-
-* On the Github Actions page, select `Update gems`
-* Select `Run workflow`
-* To attempt to update a particular gem - update the default `released_gem_name` & set the required `released_gem_version`  and then click `Run workflow`. This should be the normal process if a Pact gem has been updated.
-* To release a non-minor version change, select the `released_gem_version_increment` you want along with the above values, and click `Run workflow`.
-* If the `Gemfile.lock` is updated, the results will be committed back to the repository, along with an updated `lib/pact/cli/version.rb` set to the `released_gem_version_increment` (which defaults to minor)
-* This will trigger an automated release of the Docker image, where the Docker semver tag will be updated by a the same `released_gem_version_increment`
-
-
-## Manually releasing the Docker image
-
-* On the Github Actions page, select `Release Docker image`
-* Select `Run workflow`
-* To release a minor version change, do not set any inputs - just click `Run workflow`. This should be the normal process if you've done some changes to the Docker image.
-* To release a non-minor version change, select the increment you want, and click `Run workflow`.
-* To set a custom version number (not sure of the usecase for this, but just in case...), set both the version AND the increment and click `Run workflow`.
-* To do a completely custom tag, just set the "Custom Docker image tag" and click `Run workflow`. If you do this, the VERSION file will NOT be updated. It is for testing purposes only.

script/release-workflow/docker-push.sh

@@ -2,29 +2,22 @@
 
 set -euo >/dev/null
 
-## Publish a multi arch build with -multi added to the tag
-## ($TAG||$MAJOR_TAG||$LATEST)-multi
-push_multi() {
-  ## These will use cached builds, so wont build every time.
-  docker buildx build --platform=linux/amd64,linux/arm64,linux/arm \
-    --output=type=image,push=true \
-    -t ${DOCKER_IMAGE_ORG_AND_NAME}:$1-multi .
-}
-push() {
-  docker buildx build --platform=linux/amd64 \
-    --output=type=image,push=true \
-    -t ${DOCKER_IMAGE_ORG_AND_NAME}:$1 .
-}
-
-if [ -n "${MAJOR_TAG:-}" ]; then
-  push ${MAJOR_TAG}
-  push_multi ${MAJOR_TAG}
-fi
+# Enable when we bump the major version to 1 (which we should)
+# if [ -n "${MAJOR_TAG}" ]; then
+#   docker tag ${DOCKER_IMAGE_ORG_AND_NAME}:latest ${DOCKER_IMAGE_ORG_AND_NAME}:${MAJOR_TAG}
+#   docker push ${DOCKER_IMAGE_ORG_AND_NAME}:${MAJOR_TAG}
+#   docker push ${DOCKER_IMAGE_ORG_AND_NAME}:latest
+# fi
 
-push ${TAG}
-push_multi ${TAG}
 
-if [ "${PUSH_TO_LATEST}" != "false" ]; then
-  push latest
-  push_multi latest
-fi
+docker buildx build --platform=linux/amd64 \
+    --output=type=image,push=true \
+    -t ${DOCKER_IMAGE_ORG_AND_NAME}:latest \
+    -t ${DOCKER_IMAGE_ORG_AND_NAME}:${TAG} .
+ ## We will temporarily publish a multi manifest built as $TAG-multi
+ ## To avoid any issues with existing users. We can ask users for 
+ ## Feedback and then promote to a multi-manifest build
+docker buildx build --platform=linux/amd64,linux/arm64,linux/arm \
+    --output=type=image,push=true \
+    -t ${DOCKER_IMAGE_ORG_AND_NAME}:latest-multi \
+    -t ${DOCKER_IMAGE_ORG_AND_NAME}:${TAG}-multi .

script/release-workflow/next-docker-tag.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+set -eu
+
+gem_version_from_gemfile_lock() {
+  grep "pact_broker (" pact_broker/Gemfile.lock | awk -F '[()]' '{print $2}'
+}
+
+gem_version=$(ruby -I lib -e "require 'pact/cli/version.rb'; puts Pact::Cli::VERSION")
+existing_tags=$(git tag)
+existing_release_numbers_for_current_gem_version=$(echo "$existing_tags" | grep "${gem_version}\." | sed 's/'${gem_version}'\.//g' | grep -E "^[0-9]+$" | cat)
+
+if [ -n "${existing_release_numbers_for_current_gem_version}" ]; then
+  last_release_number=$(printf "0\n${existing_release_numbers_for_current_gem_version}" | sort -g | tail -1)
+  next_release_number=$(( $last_release_number + 1 ))
+else
+  next_release_number=0
+fi
+
+tag="${gem_version}.${next_release_number}"
+echo $tag

script/release-workflow/prepare-release.sh

@@ -1,22 +1,7 @@
 #!/bin/sh
 
 set -euo >/dev/null
-docker_compose_files=$(find . -name "docker-compose*.yml" -not -name "*test*")
-
-for file in $docker_compose_files; do
-  cat $file | sed -e "s~image: pactfoundation/pact-cli:.*~image: pactfoundation/pact-cli:${TAG}~g" > dc-tmp
-  mv dc-tmp $file
-done
 
 bundle exec conventional-changelog version=${TAG} force=true
-
-if [ -n "$VERSION" ]; then
-  bundle exec bump set $VERSION --no-commit
-  git add VERSION
-else
-  echo "Cannot update VERSION file as no VERSION has been specified"
-fi
-
 git add CHANGELOG.md
-git add docker-compose*
 git commit -m "chore(release): version ${TAG}"

script/release-workflow/set-env-vars.sh

@@ -12,27 +12,13 @@ else
     export ARCH=amd64
 fi
 
-if [ -z "$TAG" ]; then
-  if [ -n "$VERSION" ] && [ -z "$INCREMENT" ]; then
-    echo "If VERSION is specified, then INCREMENT must also be specified"
-    exit 1
-  fi
-
-  export INCREMENT=${INCREMENT:-minor}
-
-  if [ -z "$VERSION" ]; then
-    export VERSION=$(bundle exec bump show-next $INCREMENT)
-  fi
-
-  export PACT_CLI_VERSION=$(ruby -I lib -e "require 'pact/cli/version.rb'; puts Pact::Cli::VERSION")
-  export TAG="$VERSION-pactcli${PACT_CLI_VERSION}"
-  export MAJOR_TAG="$(echo $VERSION | cut -d'.' -f1)"
-
-  echo "INCREMENT=$INCREMENT"
-  echo "VERSION=$VERSION"
-  echo "PACT_CLI_VERSION=$PACT_CLI_VERSION"
-  echo "TAG=$TAG"
-  echo "MAJOR_TAG=$MAJOR_TAG"
+if [ -n "${CUSTOM_TAG:-}" ]; then
+  export TAG=$CUSTOM_TAG
+  export MAJOR_TAG=""
 else
-  echo "TAG=$TAG"
-fi
+  export TAG=$(script/release-workflow/next-docker-tag.sh)
+  export MAJOR_TAG=$(echo $TAG | cut -d'.' -f1)
+fi
+
+echo "Set TAG=${TAG}"
+echo "Set MAJOR_TAG=${MAJOR_TAG}"

script/test.sh

@@ -2,6 +2,7 @@
 
 docker build . -t pactfoundation/pact-cli
 docker run --rm pactfoundation/pact-cli:latest
+docker run --rm pactfoundation/pact-cli:latest --help
 docker run --rm pactfoundation/pact-cli:latest mock-service --help
 docker run --rm pactfoundation/pact-cli:latest pact-broker --help
 docker run --rm pactfoundation/pact-cli:latest pactflow --help