THX-1138: mono-repo

AlexAtkinson · AlexAtkinson · commit 825f97c037fd · 2024-12-17T15:47:33.000-05:00
diff --git a/.github/workflows/build-and-release.yml b/.github/workflows/build-and-release.yml
@@ -27,7 +27,7 @@ jobs:
           echo "FUNCTION=$FUNCTION" >> $GITHUB_ENV
       - name: Run GitOps Automatic Versioning Action
         id: gitops-autover
-        uses: AlexAtkinson/github-action-gitops-autover@0.1.7
+        uses: AlexAtkinson/github-action-gitops-autover@0.3.1
       - name: Set Version Dependent Envars
         run: |
           VERSION=${{ steps.gitops-autover.outputs.new-version }}
@@ -47,4 +47,4 @@ jobs:
           automatic_release_tag: "${{ env.VERSION }}"
           title: "${{ env.VERSION }}"
           files: |
-            ${{ env.ZIPFILE }}
+            ${{ env.ZIPFILE }}
diff --git a/README.md b/README.md
@@ -8,14 +8,27 @@
 <!-- https://github.com/marketplace/actions/count-action-users -->
 <!-- ![HitCount](https://hits.dwyl.com/AlexAtkinson/github-action-gitops-autover.svg?style=flat-square) -->
 
-Language/content agnostic method of automatically determining the [semantic version](https://semver.org/) for a product based on _branch_ merge history with MINIMAL discipline dependencies.
+Language/content agnostic method of automatically determining the [semantic version](https://semver.org/) for a product based on _branch_ merge history with MINIMAL [discipline dependencies](https://github.com/marketplace/actions/gitops-automatic-versioning?#discipline-dependency).
 
 This is accomplished by counting the merges of branches matching the [naming scheme](#branch-naming-scheme) into the [main|master] branch. Folks familiar with Scrum/SAFe or GitFlow/fooFlow strategies will recognize this scheme.
 
-**Yes**, this can be implemented in repos that previously used different version increment methods.
+**Burning Questions**
+
+- **Yes** - This can indeed be implemented in repos that previously used different version increment methods.
+- **Yes** - Jira will recognize the issue tag anywhere in the branch name -- it does not have to be a prefix for the integration to function.
+- **Yes** - This aligns with and extends on [guidance](https://confluence.atlassian.com/bitbucketserver050/using-branches-in-bitbucket-server-913474726.html) from Atlassian on branch naming schemes.
 
 > [Convenience link to this action on the marketplace](https://github.com/marketplace/actions/gitops-automatic-versioning)
 
+## Recent Changes
+
+- 1.0.0: (non-breaking) Addition of support for mono-repos. IE: Discretely version specific directories.
+  - NOTE: Github, Jira, etc., were designed to host one product per repo/project. DO NOT create new mono-repo projects unless you're specifically tooling out to support them well.
+- 0.3.1: Update the checkout action version to v4.
+- 0.3.0: Bring back the unshallowing, which ensures the full git log is available.
+  - TODO: Adjust scripts to use `git log --remotes` to avoid unshallowing large repos.
+- 0.2.9: Fix 'ops' increments; add user friendly error outputs.
+
 ## Usage
 
 ### Setup
@@ -45,6 +58,33 @@ git push --set-upstream origin fix/not-a-feature
 # THEN: Click the link to create a PR & merge it</pre></dd>
 </dl>
 
+### Inputs
+
+Note: Only required for setting up mono-repo versioning.
+
+<dl>
+  <dt>mono-repo-mode: [bool]</dt>
+    <dd>Enable semver matching against any tag structure that includes a valid semver string.<br>
+    Eg: '&lt;product-name&gt;_&lt;semver&gt;'<br>
+    <i>Required:</i> false<br>
+    <i>Default:</i> false</dd>
+  <dt>mono-repo-product-name: [string]</dt>
+    <dd>The product name to match against.<br>
+    Eg: 'bob', would match the tags like 'bob_1.2.3'.<br>
+    <i>Required:</i> if mono-repo-mode: true<br>
+    <i>Default:</i> ''</dd>
+  <dt>mono-repo-product-path: [string]</dt>
+    <dd>The path to the product.<br>
+    Eg: path/to/bob<br>
+    <i>Required:</i> if mono-repo-mode: true<br>
+    <i>Default:</i> ''</dd>
+  <dt>force-patch-increment: [bool]</dt>
+    <dd>Forces a PATCH increment if no other increment detected.<br>
+    (Intended for development purposes only.)<br>
+    <i>Required:</i> false<br>
+    <i>Default:</i> false</dd>
+</dl>
+
 ### Outputs
 
 <dl>
@@ -73,14 +113,23 @@ Below is a valid workflow utilizing this action. If you wanted to extend it to d
         - uses: actions/checkout@v3
         - name: Run GitOps Automatic Versioning Action
           id: gitops-autover
-          uses: AlexAtkinson/github-action-gitops-autover@0.1.7
+          uses: AlexAtkinson/github-action-gitops-autover@0.3.0
         - name: Verify Outputs
           run: |
             NEW_VERSION=${{ steps.gitops-autover.outputs.new-version }}
             echo "new-version: $NEW_VERSION"
             PREVIOUS_VERSION=${{ steps.gitops-autover.outputs.previous-version }}
             echo "previous-version: $PREVIOUS_VERSION"
 
+To make use of the mono-repo support, simply add a block for the director you wish to version.
+
+        - name: Run GitOps Automatic Versioning Action
+          id: gitops-autover
+          uses: AlexAtkinson/github-action-gitops-autover@0.3.0
+          with:
+            mono-repo-mode: true
+            mono-repo-product-name: bob
+
 This results in outputs like:
 
 _major:_
@@ -140,7 +189,7 @@ Additionally, this repo uses its own action for versioning, so feel free to inve
             echo "PRODUCT_NAME_LOWER=$PRODUCT_NAME_LOWER" >> $GITHUB_OUTPUT
         - name: GitOps Automatic Versioning
           id: gitops-autover
-          uses: AlexAtkinson/github-action-gitops-autover@0.1.7
+          uses: AlexAtkinson/github-action-gitops-autover@0.3.0
       build:
         name: "Build"
         runs-on: ubuntu-latest
@@ -254,5 +303,5 @@ For those interested, here's some pseudo code:
 PRs are welcome.
 
 - input(s): iteration-branches (map) - inform MINOR and PATCH incrementing branch name patterns.
-- input(s): mono-mode (bool) - version subdirs discretely
-- ~~CAN'T DO~~: DONE: unshallow from last version tag to latest commit to... Seems a limitation of (git at first glance). See the [Checkout From Tag](https://github.com/marketplace/actions/checkout-from-tag) action.
+- DONE: input(s): mono-mode (bool) - version subdirs discretely
+- UNDONE-CAN'T DO: ~~CAN'T DO~~: ~~DONE:~~ unshallow from last version tag to latest commit to... Seems a limitation of (git at first glance). See the [Checkout From Tag](https://github.com/marketplace/actions/checkout-from-tag) action.
diff --git a/action.yml b/action.yml
@@ -13,6 +13,18 @@ inputs:
     description: "Forces a PATCH increment if no other increment detected. NOTE: This is intended for development purposes only."
     required: false
     default: 'false'
+  mono-repo-mode:
+    description: "Enable semver matching against any tag structure that includes a valid semver string. Eg: <product-name>_<semver>"
+    required: false
+    default: 'false'
+  mono-repo-product-name:
+    description: "The product name to match against. For example, 'bob', would match the tags like 'bob_1.2.3'. Required if 'mono-repo-mode' is enabled."
+    required: false
+    default: ''
+  mono-repo-product-path:
+    description: "The path to the product. IE: 'path/to/bob'. Required if 'mono-repo-mode' is enabled."
+    required: false
+    default: ''
 outputs:
   new-version:
     description: "New Version"
@@ -23,8 +35,13 @@ outputs:
 runs:
   using: "composite"
   steps:
-    - name: Checkout to the depth of the last DETECTED version.
-      uses: AlexAtkinson/github-action-checkout-from-tag@latest
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Ensure full commit history
+      run: |
+          cd $GITHUB_WORKSPACE
+          git pull --unshallow
+      shell: bash
     - name: Detect Previous Version
       id: previous-version
       run: |
@@ -36,27 +53,37 @@ runs:
       run: |
           cd $GITHUB_WORKSPACE
           opt=''
-          [[ "${{ inputs.force-re-evaluate }}" == 'true' ]] && opt='-f'
-          [[ "${{ inputs.force-re-evaluate }}" == 'true' ]] && opt='-p'
-          new_version="$(${{ github.action_path }}/scripts/detectNewVersion.sh $opt)"
+          [[ "${{ inputs.force-re-evaluate }}" == 'true' ]] && opt='$opt -f'
+          [[ "${{ inputs.force-patch-increment }}" == 'true' ]] && opt='$opt -p'
+          [[ "${{ inputs.mono-repo-mode }}" == 'true' ]] && opt='$opt -m'
+          if [[ "${{ inputs.mono-repo-mode }}" == 'true' && -z ${{ inputs.mono-repo-product-name }} ]]; then
+            echo -e "ERROR: 571 - mono-repo-product-name must be set and NOT null!"
+            exit 1 || true
+          fi
+          [[ -n "${{ inputs.mono-repo-product-name }}" ]] && opt='$opt -n ${{ inputs.mono-repo-product-name }}'
+          new_version="$(${{ github.action_path }}/scripts/detectNewVersion.sh $opt)" || true
           echo "new-version=$new_version" | tee $GITHUB_OUTPUT
+          if [[ "$new_version" =~ "520" ]]; then
+            echo -e "ERROR: 520 - You must source this script when specifying an environment variable! Eg: '. ./foo.sh -e bar_ver'"
+            exit 1 || true
+          fi
           if [[ "$new_version" =~ "570" ]]; then
-            echo -e "\e[01;31mERROR\e[00m: 570 - Invalid argument!"
+            echo -e "ERROR: 570 - Invalid argument!"
             exit 1 || true
           fi
           if [[ "$new_version" =~ "590" ]]; then
-            echo -e "\e[01;31mFATAL\e[00m: 501 - This is not a git repository!"
+            echo -e "FATAL: 501 - This is not a git repository!"
             exit 1 || true
           fi
           if [[ "$new_version" =~ "591" ]]; then
-            echo -e "\e[01;31mERROR\e[0m: 591 - Unsupported origin host."
+            echo -e "ERROR: 591 - Unsupported origin host."
             exit 1 || true
           fi
           if [[ "$new_version" =~ "599" ]]; then
-            echo -e "\e[01;31mERROR\e[00m: 599 - No feature, enhancement, fix, bugfix, hotfix, or ops branches detected!"
+            echo -e "ERROR: 599 - No feature, enhancement, fix, bugfix, hotfix, or ops branches detected!"
             exit 1 || true
           fi
       shell: bash
 
 # See github contexts for more like github.action_path.
-# REF: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
+# REF: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
diff --git a/scripts/detectNewVersion.sh b/scripts/detectNewVersion.sh
@@ -47,6 +47,13 @@ DESCRIPTION
       -p      Increments PATCH version on _every_ run.
               WARN: This is intended development use only.
 
+      -m      Enables mono-repo mode, allowing matching against semvers prefixed with
+              a product name. Eg: 'cool-app_1.2.3'
+
+      -n      The product name to match against. EG: 'bob' would match tags like 'bob_1.2.3'.
+
+      -d      The directory of the product to version. EG: 'path/to/bob'.
+
 EXAMPLES
       The following detects the new version for the repo.
 
@@ -75,7 +82,7 @@ fi
 # --------------------------------------------------------------------------------------------------
 
 OPTIND=1
-while getopts "he:vfp" opt; do
+while getopts "he:vfpmn:d:" opt; do
   case $opt in
     h)
       printHelp
@@ -95,9 +102,23 @@ while getopts "he:vfp" opt; do
     p)
       arg_p='set'
       ;;
+    m)
+      arg_m='set'
+      arg_opts="$arg_opts -m"
+      ;;
+    n)
+      arg_n='set'
+      arg_n_val="$OPTARG"
+      arg_opts="$arg_opts -n $OPTARG"
+      ;;
+    d)
+      arg_d='set'
+      arg_d_val="$OPTARG"
+      arg_d_opt="--full-history"
+      arg_opts="$arg_opts -d $OPTARG"
+      ;;
     *)
       echo -e "\e[01;31mERROR\e[00m: 570 - Invalid argument!"
-    echo "::error title=Argument Error::ERROR 570 - Invalid argument!"
       printHelp
       if [[ "$sourced" == 0 ]]; then
         exit 0
@@ -119,13 +140,13 @@ tsCmd='date --utc +%FT%T.%3NZ'
 relative_path="$(dirname "${BASH_SOURCE[0]}")"
 dir="$(realpath "${relative_path}")"
 
-lastVersion=$(/usr/bin/env bash -c "${dir}/detectPreviousVersion.sh")
-lastVersionMajor=$(/usr/bin/env bash -c "${dir}/validateSemver.sh -p major $lastVersion")
-lastVersionMinor=$(/usr/bin/env bash -c "${dir}/validateSemver.sh -p minor $lastVersion")
-lastVersionPatch=$(/usr/bin/env bash -c "${dir}/validateSemver.sh -p patch $lastVersion")
-lastVersionCommitHash=$(/usr/bin/env bash -c "${dir}/detectPreviousVersion.sh -c")
+lastVersion=$(/usr/bin/env bash -c "${dir}/detectPreviousVersion.sh -9 $arg_opts")
+lastVersionMajor=$(/usr/bin/env bash -c "${dir}/validateSemver.sh -p major $lastVersion $arg_opts")
+lastVersionMinor=$(/usr/bin/env bash -c "${dir}/validateSemver.sh -p minor $lastVersion $arg_opts")
+lastVersionPatch=$(/usr/bin/env bash -c "${dir}/validateSemver.sh -p patch $lastVersion $arg_opts")
+lastVersionCommitHash=$(/usr/bin/env bash -c "${dir}/detectPreviousVersion.sh -9 -c $arg_opts")
 lastCommitHash=$(git rev-parse HEAD)
-firstCommitHash=$(git rev-list --max-parents=0 HEAD)
+firstCommitHash=$(git rev-list --max-parents=0 HEAD | tail -n 1)
 
 ci_name=$("${dir}/detect-ci.sh")
 origin=$(git config --get remote.origin.url)
@@ -155,7 +176,6 @@ case "$origin_host" in
   ;;
   *)
     echo -e "\e[01;31mERROR\e[0m: 591 - Unsupported origin host."
-    echo "::error title=Origin Host Error::ERROR 591 - Unsupported origin host!"
     exit 1
   ;;
 esac
@@ -167,25 +187,24 @@ esac
 if [[ -n $arg_e ]]; then
   if [[ "$sourced" == 0 ]]; then
     echo -e "[$(${tsCmd})] \e[01;31mERROR\e[00m: 520 - You must source this script when specifying an environment variable! Eg: '. ./${0##*/} -e foo_ver'\n"
-    echo "::error title=Usage Error::ERROR 520 - You must source this script when specifying an environment variable! Eg: '. ./foo.sh -e bar_ver'"
     exit 1
   fi
 fi
 
-git log --pretty=oneline "$lastVersionCommitHash".."$lastCommitHash" | grep '+semver' | grep -q 'major\|breaking' && incrementMajor='true'
+git log $arg_d_opt --pretty=oneline "$lastVersionCommitHash".."$lastCommitHash" $arg_d_val | grep '+semver' | grep -q 'major\|breaking' && incrementMajor='true'
 
 if [[ $incrementMajor != 'true' ]]; then
   IFS=$'\r\n'
   if [[ -n $arg_f ]]; then
-    for i in $(git log --pretty=oneline "${firstCommitHash}".."${lastCommitHash}" | awk -v s="$merge_string" -v c="$column" '$0 ~ s {print $c}' | awk -v f="$field" -F'/' '{print $f}' | tr -d "'" | grep -i '^enhancement$\|^feature$\|^fix$\|^hotfix$\|^bugfix$\|^ops$' | awk -F '\r' '{print $1}' | sort | uniq -c | sort -nr) ; do
+    for i in $(git log $arg_d_opt --pretty=oneline "${firstCommitHash}".."${lastCommitHash}" $arg_d_val | awk -v s="$merge_string" -v c="$column" '$0 ~ s {print $c}' | awk -v f="$field" -F'/' '{print $f}' | tr -d "'" | grep -i '^enhancement$\|^feature$\|^fix$\|^hotfix$\|^bugfix$\|^ops$' | awk -F '\r' '{print $1}' | sort | uniq -c | sort -nr) ; do
       varname=$(echo "$i" | awk '{print $2}')
       varname=${varname,,}
       value=$(echo "$i" | awk '{print $1}')
       value=${value,,}
       declare count_"$varname"="$value"
     done
   else
-    for i in $(git log --pretty=oneline "${lastVersionCommitHash}".."${lastCommitHash}" | awk -v s="$merge_string" -v c="$column" '$0 ~ s {print $c}' | awk -v f="$field" -F'/' '{print $f}' | tr -d "'" | grep -i '^enhancement$\|^feature$\|^fix$\|^hotfix$\|^bugfix$\|^ops$' | awk -F '\r' '{print $1}' | sort | uniq -c | sort -nr) ; do
+    for i in $(git log $arg_d_opt --pretty=oneline "${lastVersionCommitHash}".."${lastCommitHash}" $arg_d_val | awk -v s="$merge_string" -v c="$column" '$0 ~ s {print $c}' | awk -v f="$field" -F'/' '{print $f}' | tr -d "'" | grep -i '^enhancement$\|^feature$\|^fix$\|^hotfix$\|^bugfix$\|^ops$' | awk -F '\r' '{print $1}' | sort | uniq -c | sort -nr) ; do
       varname=$(echo "$i" | awk '{print $2}')
       varname=${varname,,}
       value=$(echo "$i" | awk '{print $1}')
@@ -208,7 +227,6 @@ if [[ -n $arg_f ]]; then
 else
   if [[ -z $incrementMajor && -z $count_feature && -z $count_enhancement && -z $count_fix && -z $count_bugfix && -z $count_hotfix && -z $count_ops ]]; then
     echo -e "\e[01;31mERROR\e[00m: 599 - No feature, enhancement, fix, bugfix, hotfix, or ops branches detected!"
-    echo "::error title=No Valid Merge Detected::ERROR 599 - No feature, enhancement, fix, bugfix, hotfix, or ops branches detected!"
     exit 1
   fi
 fi
@@ -240,7 +258,8 @@ elif [[ -n $arg_p ]]; then
   newVersionPatch=$((lastVersionPatch + 1))
 fi
 
-newVersion=$(/usr/bin/env bash -c "${dir}/validateSemver.sh -9p full $newVersionMajor.$newVersionMinor.$newVersionPatch")
+newVersion=$(/usr/bin/env bash -c "${dir}/validateSemver.sh -9p full $newVersionMajor.$newVersionMinor.$newVersionPatch $arg_opts")
+[[ -n $arg_n ]] && newVersion="${arg_n_val}_${newVersion}"
 
 if [[ -n $arg_e ]]; then
   export_var="$arg_e_val"
diff --git a/scripts/detectPreviousVersion.sh b/scripts/detectPreviousVersion.sh
diff --git a/scripts/validateSemver.sh b/scripts/validateSemver.sh
