Merge #2530

2530: Check the version in Cargo.toml before publishing r=irevoire a=curquiza

Fixes #2079 

Also
- improves the current docker CI for v0.28.0: the current implementation will make run 2 CI instead of just one for the official release
- move the `is-latest-releaes.sh` script, and update the documentation comment
- fix version of permissive-json-pointer

How to test the script?

```
export GITHUB_REF='refs/tags/v0.28.0'
sh .github/scripts/check-release.sh
```

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>

.github/scripts/check-release.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+# check_tag $current_tag $file_tag $file_name
+function check_tag {
+  if [ "$1" != "$2" ]; then
+      echo "Error: the current tag does not match the version in $3: found $1 - expected $2"
+      ret=1
+  fi
+}
+
+ret=0
+current_tag=$(echo $GITHUB_REF | tr -d 'refs/tags/v')
+
+toml_files='*/Cargo.toml'
+for toml_file in $toml_files;
+do
+    file_tag="$(grep '^version = ' $toml_file | cut -d '=' -f 2 | tr -d '"' | tr -d ' ')"
+    check_tag $current_tag $file_tag $toml_file
+done
+
+lock_file='Cargo.lock'
+lock_tag=$(grep -A 1 'name = "meilisearch-auth"' $lock_file | grep version | cut -d '=' -f 2 | tr -d '"' | tr -d ' ')
+check_tag $current_tag $lock_tag $lock_file
+
+if [ "$ret" -eq 0 ] ; then
+  echo 'OK'
+fi
+exit $ret

.github/scripts/is-latest-release.sh

@@ -1,14 +1,14 @@
 #!/bin/sh
 
-# Checks if the current tag should be the latest (in terms of semver and not of release date).
-# Ex: previous tag -> v0.10.1
-#     new tag -> v0.8.12
-#     The new tag should not be the latest
-#     So it returns "false", the CI should not run for the release v0.8.2
-
-# Used in GHA in publish-docker-latest.yml
+# Was used in our CIs to publish the latest docker image. Not used anymore, will be used again when v1 and v2 will be out and we will want to maintain multiple stable versions.
 # Returns "true" or "false" (as a string) to be used in the `if` in GHA
 
+# Checks if the current tag should be the latest (in terms of semver and not of release date).
+# Ex: previous tag -> v2.1.1
+#     new tag -> v1.20.3
+#     The new tag (v1.20.3) should NOT be the latest
+#     So it returns "false", the `latest` tag should not be updated for the release v1.20.3 and still need to correspond to v2.1.1
+
 # GLOBAL
 GREP_SEMVER_REGEXP='v\([0-9]*\)[.]\([0-9]*\)[.]\([0-9]*\)$' # i.e. v[number].[number].[number]
 

.github/workflows/publish-binaries.yml

@@ -5,9 +5,18 @@ on:
 name: Publish binaries to release
 
 jobs:
+  check-version:
+    name: Check the version validity
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Check release validity
+        run: sh .github/scripts/check-release.sh
+
   publish:
     name: Publish binary for ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
+    needs: check-version
     strategy:
       fail-fast: false
       matrix:
@@ -41,6 +50,7 @@ jobs:
   publish-aarch64:
     name: Publish binary for aarch64
     runs-on: ${{ matrix.os }}
+    needs: check-version
     continue-on-error: false
     strategy:
       fail-fast: false

.github/workflows/publish-deb-brew-pkg.yml

@@ -5,9 +5,18 @@ on:
     types: [released]
 
 jobs:
+  check-version:
+    name: Check the version validity
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Check release validity
+        run: sh .github/scripts/check-release.sh
+
   debian:
     name: Publish debian packagge
     runs-on: ubuntu-18.04
+    needs: check-version
     steps:
     - uses: hecrj/setup-rust-action@master
       with:
@@ -30,6 +39,7 @@ jobs:
   homebrew:
     name: Bump Homebrew formula
     runs-on: ubuntu-18.04
+    needs: check-version
     steps:
       - name: Create PR to Homebrew
         uses: mislav/bump-homebrew-formula-action@v1

.github/workflows/publish-docker-images.yml

@@ -5,8 +5,6 @@ on:
   push:
     tags:
       - '*'
-  release:
-    types: [released]
 
 name: Publish tagged images to Docker Hub
 
@@ -14,45 +12,54 @@ jobs:
   docker:
     runs-on: docker
     steps:
+      - uses: actions/checkout@v2
+
+      # Check if the tag has the v<nmumber>.<number>.<number> format. If yes, it means we are publishing an official release.
+      # In this situation, we need to set `output.stable` to create/update the following tags (additionally to the `vX.Y.Z` Docker tag):
+      # - a `vX.Y` (without patch version) Docker tag
+      # - a `latest` Docker tag
+      - name: Check tag format
+        if: github.event_name != 'schedule'
+        id: check-tag-format
+        run: |
+          escaped_tag=$(printf "%q" ${{ github.ref_name }})
+
+          if [[ $escaped_tag =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo ::set-output name=stable::true
+          else
+            echo ::set-output name=stable::false
+          fi
+
+      # Check only the validity of the tag for official releases (not for pre-releases or other tags)
+      - name: Check release validity
+        if: github.event_name != 'schedule' && steps.check-tag-format.outputs.stable
+        run: sh .github/scripts/check-release.sh
+
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v1
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
 
-      - name: Login to DockerHub
+      - name: Login to Docker Hub
         if: github.event_name != 'schedule'
         uses: docker/login-action@v1
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
-      - name: Check tag format
-        id: check-tag-format
-        run: |
-          # Escape submitted tag name
-          escaped_tag=$(printf "%q" ${{ github.ref_name }})
-
-          # Check if tag has format v<nmumber>.<number>.<number> and set output.match
-          # to create a vX.Y (without patch version) Docker tag
-          if [[ $escaped_tag =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
-            echo ::set-output name=match::true
-          else
-            echo ::set-output name=match::false
-          fi
-
       - name: Docker meta
         id: meta
         uses: docker/metadata-action@v3
         with:
           images: getmeili/meilisearch
-          # The lastest tag is only pushed for the official Meilisearch release
+          # The lastest and `vX.Y` tags are only pushed for the official Meilisearch releases
           # See https://github.com/docker/metadata-action#latest-tag
           flavor: latest=false
           tags: |
             type=ref,event=tag
-            type=semver,pattern=v{{major}}.{{minor}},enable=${{ steps.check-tag-format.outputs.match }}
-            type=raw,value=latest,enable=${{ github.event_name == 'release' }}
+            type=semver,pattern=v{{major}}.{{minor}},enable=${{ steps.check-tag-format.outputs.stable }}
+            type=raw,value=latest,enable=${{ steps.check-tag-format.outputs.stable }}
 
       - name: Build and push
         id: docker_build

Cargo.lock

@@ -2515,7 +2515,7 @@ checksum = "d4fd5641d01c8f18a23da7b6fe29298ff4b55afcccdf78973b24cf3175fee32e"
 
 [[package]]
 name = "permissive-json-pointer"
-version = "0.2.0"
+version = "0.28.0"
 dependencies = [
  "big_s",
  "serde_json",

permissive-json-pointer/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "permissive-json-pointer"
-version = "0.2.0"
+version = "0.28.0"
 edition = "2021"
 description = "A permissive json pointer"
 readme = "README.md"