[CI/CD] Readme / Change-log Action Verification (#238)

* basic workflow

* scripts

* makefile

* proper workflow

* better messages

* use get next version script

---------

Co-authored-by: Kyle Roe <[hopeman15@users.noreply.github.com]>

Author: hopeman15

.github/workflows/verify-doc.yml

@@ -0,0 +1,28 @@
+name: Verify Documentation
+
+on:
+  pull_request:
+    types: [ synchronize, opened, reopened, labeled, unlabeled ]
+
+jobs:
+  check_docs:
+    if: ${{ contains(github.event.pull_request.labels.*.name, 'release :tada:') }}
+    name: Check Changelog/Readme
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+    strategy:
+      matrix:
+        file: [ 'website/docs/changelog.md','README.md' ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Major
+        if: ${{ contains(github.event.*.labels.*.name, 'major :1st_place_medal:') }}
+        run: make verify-doc BUMP=major FILE=${{ matrix.file }}
+      - name: Minor
+        if: ${{ contains(github.event.*.labels.*.name, 'minor :2nd_place_medal:') }}
+        run: make verify-doc BUMP=minor FILE=${{ matrix.file }}
+      - name: Patch
+        if: ${{ contains(github.event.*.labels.*.name, 'patch :3rd_place_medal:') }}
+        run: make verify-doc BUMP=patch FILE=${{ matrix.file }}

Makefile

@@ -1,6 +1,7 @@
 BUMP ?= patch
+FILE ?= empty
 
-.PHONY: all build clean dependencies coverage format lint local publish test version \
+.PHONY: all build clean dependencies coverage format lint local publish test verify-doc version \
 build-docs install-docs start-docs upgrade-docs
 
 all: clean format lint test coverage build
@@ -32,6 +33,9 @@ publish:
 test:
 	./gradlew test
 
+verify-doc:
+	./scripts/verify-doc.sh ${BUMP} ${FILE}
+
 version:
 	./scripts/create-release.sh ${BUMP}
 

scripts/create-release.sh

@@ -4,23 +4,8 @@ set -o pipefail
 
 RELEASE_TYPE=${1}
 
-# Get current release version
-git fetch --force --tags
-CURRENT_RELEASE=$(git tag --sort=committerdate | tail -1)
+NEW_RELEASE=$(./scripts/get_next_version.sh "$RELEASE_TYPE")
 
-# Separate major, minor and patch numbers
-IFS='.' read -r MAJOR MINOR PATCH <<<"$CURRENT_RELEASE"
-
-# $/${} is unnecessary on arithmetic variables.
-# shellcheck disable=SC2004
-if [[ "${RELEASE_TYPE}" == "major" ]]; then
-  NEW_RELEASE="$(($MAJOR + 1)).0.0"
-elif [ "${RELEASE_TYPE}" == "minor" ]; then
-  NEW_RELEASE="$MAJOR.$(($MINOR + 1)).0"
-else
-  NEW_RELEASE="$MAJOR.$MINOR.$(($PATCH + 1))"
-fi
-
-echo "Bumping version from $CURRENT_RELEASE to $NEW_RELEASE"
+echo "Bumping version to $NEW_RELEASE"
 
 gh release create "$NEW_RELEASE" --target "main" --generate-notes

scripts/get_next_version.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+set -o pipefail
+
+RELEASE_TYPE=${1}
+
+# Get current release version
+git fetch --force --tags
+CURRENT_RELEASE=$(git tag --sort=committerdate | tail -1)
+
+# Separate major, minor and patch numbers
+IFS='.' read -r MAJOR MINOR PATCH <<<"$CURRENT_RELEASE"
+
+# $/${} is unnecessary on arithmetic variables.
+# shellcheck disable=SC2004
+if [[ "${RELEASE_TYPE}" == "major" ]]; then
+  NEW_RELEASE="$(($MAJOR + 1)).0.0"
+elif [ "${RELEASE_TYPE}" == "minor" ]; then
+  NEW_RELEASE="$MAJOR.$(($MINOR + 1)).0"
+else
+  NEW_RELEASE="$MAJOR.$MINOR.$(($PATCH + 1))"
+fi
+
+echo "$NEW_RELEASE"

scripts/verify-doc.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+set -o pipefail
+
+RELEASE_TYPE=${1}
+FILE=${2}
+
+VERSION=$(./scripts/get_next_version.sh "$RELEASE_TYPE")
+
+echo "Verifying version $VERSION is defined in: $FILE."
+if grep -R "$VERSION" "$FILE"; then
+  echo "Version info found."
+  exit 0
+else
+  echo "Version info not found in: $FILE"
+  exit 1
+fi