Release V3.0.0

.github/workflows/development-publish.yml

@@ -0,0 +1,26 @@
+name: Publish development branch on Merge
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - development
+  # On close of PR targeting development
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  release_on_merge:
+    if: github.event.pull_request.merged == true
+    name: Tag and Publish UPM package
+    uses: ./.github/workflows/upversionandtagrelease.yml
+    with:
+      build-host: ubuntu-latest
+      build-type: pre-release
+    secrets: inherit

.github/workflows/getpackageversionfrompackage.yml

@@ -0,0 +1,70 @@
+name: Get the Package version from a UPM Package.json file
+
+on:
+  workflow_call:
+    inputs:
+      build-host:
+        required: true
+        type: string
+      version-file-path:
+        description: 'Optional, specify a path to search for the upm package.json file. Use this if validation fails to find a valid package.json file.\n **Note, Version file MUST contain the attribute "Unity" with the full Unity version expected, e.g. "2020.2.3f1"'
+        type: string
+        required: false
+    outputs:
+      packageversion:
+        description: "Returns the version of the UPM package"
+        value: ${{ jobs.get_package_version.outputs.upmpackageversion }}
+
+jobs:
+  get_package_version:
+    name: Get required Package version from UPM Package
+    runs-on: ${{ inputs.build-host }}
+    outputs:
+      upmpackageversion: ${{ steps.getVersion.outputs.packageversion }}
+    steps:
+      - name: Script Version
+        run: |
+          echo "::group::Script Versioning"
+          $scriptVersion = "1.0.0"
+          echo "Build Script Version: $scriptVersion"
+          echo "::endgroup::"
+        shell: pwsh
+      - uses: actions/checkout@v7
+        with:
+          submodules: recursive
+          clean: true
+      - id: getVersion
+        name: 'Get Package Version Number'
+        run: |
+          echo "::group::Validating input"
+
+          $versionFile = "${{ inputs.version-file-path }}"
+          if([string]::IsNullOrEmpty($versionFile))
+          {
+            echo 'version input was empty, using default'
+            $versionFile = 'package.json'
+          }
+          echo 'Checking for project json at $versionFile'
+
+          if ( -not (Test-Path -Path $versionFile) ) {
+            Write-Error "Failed to find a valid package.json file"
+            exit 1
+          }
+
+          echo "::endgroup::"
+
+          echo "::group::Package Version UPM check"
+
+          $package_json = Get-Content -Path $versionFile | ConvertFrom-Json
+          $packageVersion = $package_json.version
+
+          if([string]::IsNullOrEmpty($packageVersion)) {
+            Write-Error "Project.json version number does not exist or is empty"
+            exit 1
+          }
+
+          echo "packageversion=$packageVersion" >> $env:GITHUB_OUTPUT
+
+          echo "Detected version is $packageVersion"
+          echo "::endgroup::"
+        shell: pwsh

.github/workflows/main-publish.yml

@@ -0,0 +1,91 @@
+name: Publish main branch and increment version
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - release
+
+jobs:
+  # Get Version to tag and release the branch, no up-version - [no-ver] included in PR title
+  validate-environment:
+    if: github.event.pull_request.merged == true && contains(github.event.pull_request.title, 'no-ver')
+    name: Get Version from UPM package
+    uses: ./.github/workflows/getpackageversionfrompackage.yml
+    with:
+      build-host: ubuntu-latest
+
+  # Perform tagging
+  release-Package-only:
+    needs: validate-environment
+    name: Release package only, no upversion
+    uses: ./.github/workflows/tagrelease.yml
+    with:
+      build-host: ubuntu-latest
+      version: ${{ needs.validate-environment.outputs.packageversion }}
+    secrets: inherit
+
+  # Up version the release and publish major release
+  upversion-major-Package:
+    if: github.event.pull_request.merged == true && contains(github.event.pull_request.title, 'no-ver') == false && contains(github.event.pull_request.title, 'major-release')
+    name: Major Version package and release
+    uses: ./.github/workflows/upversionandtagrelease.yml
+    with:
+      build-host: ubuntu-latest
+      build-type: major
+    secrets: inherit
+
+  # Up version the release and publish minor release
+  upversion-minor-Package:
+    if: github.event.pull_request.merged == true && contains(github.event.pull_request.title, 'no-ver') == false && contains(github.event.pull_request.title, 'minor-release')
+    name: Minor Version package and release
+    uses: ./.github/workflows/upversionandtagrelease.yml
+    with:
+      build-host: ubuntu-latest
+      build-type: minor
+    secrets: inherit
+
+  # Up version the release and publish patch release (default)
+  upversion-patch-Package:
+    if: github.event.pull_request.merged == true && contains(github.event.pull_request.title, 'no-ver') == false && contains(github.event.pull_request.title, 'minor-release') == false && contains(github.event.pull_request.title, 'major-release') == false
+    name: Patch Version package and release
+    uses: ./.github/workflows/upversionandtagrelease.yml
+    with:
+      build-host: ubuntu-latest
+      build-type: patch-release
+    secrets: inherit
+
+  release-Complete:
+    if: ${{ always() }}
+    needs: [upversion-major-Package, upversion-minor-Package, upversion-patch-Package, release-Package-only]   
+    name: Release complete
+    runs-on: ubuntu-latest
+    steps:
+      - name: Script Version
+        run: echo "Release done, updating Development"
+
+  # Refresh the development branch with the main publish
+  refresh-development:
+    if: ${{ always() }}
+    needs: [release-Complete]
+    name: Refresh development branch
+    uses: ./.github/workflows/refreshbranch.yml
+    with:
+      build-host: ubuntu-latest
+      target-branch: development
+      source-branch: main
+    secrets: inherit
+
+  # Up version the development branch ready for future development
+  upversion-development:
+    if: ${{ always() }}
+    needs: [refresh-development]
+    name: UpVersion the development branch for the next release
+    uses: ./.github/workflows/upversionandtagrelease.yml
+    with:
+      build-host: ubuntu-latest
+      build-type: patch
+      target-branch: development
+      createTag: false
+    secrets: inherit

.github/workflows/refreshbranch.yml

@@ -0,0 +1,43 @@
+name: Refresh branch
+
+on:
+  workflow_call:
+    inputs:
+      build-host:
+        required: true
+        type: string    
+      target-branch:
+        required: true
+        type: string
+      source-branch:
+        required: true
+        type: string
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  packageRelease:
+    name: Refresh ${{ inputs.target-branch }} branch from ${{ inputs.source-branch }} branch
+    runs-on: ${{ inputs.build-host }}
+    steps:
+      - name: Script Version
+        run: |
+          echo "::group::Script Versioning"
+          $scriptVersion = "1.0.1"
+          echo "Build Script Version: $scriptVersion"
+          echo "::endgroup::"
+        shell: pwsh   
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ inputs.target-branch }}
+          clean: true
+          token: ${{ secrets.GIT_PAT }}
+      - name: Refresh from Source Branch
+        run: |
+          git pull origin ${{ inputs.source-branch }}
+          git commit -m "Branch ${{ inputs.target-branch }} updated with changes from ${{ inputs.source-branch }} [skip ci]"
+          git push origin ${{ inputs.target-branch }}
+          echo "Branch ${{ inputs.target-branch }} updated with changes from ${{ inputs.source-branch }}"
+        shell: pwsh

.github/workflows/tagrelease.yml

@@ -0,0 +1,77 @@
+name: Tag Release
+
+on:
+  workflow_call:
+    inputs:
+      build-host:
+        required: true
+        type: string    
+      version:
+        required: true
+        type: string
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  packageRelease:
+    name: Package UPM Project and tag
+    runs-on: ${{ inputs.build-host }}
+    steps:
+      - name: Script Version
+        run: |
+          echo "::group::Script Versioning"
+          $scriptVersion = "1.0.2"
+          echo "Build Script Version: $scriptVersion"
+          echo "::endgroup::"
+        shell: pwsh   
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+          submodules: recursive
+          clean: true
+          token: ${{ secrets.GIT_PAT }}
+      - uses: actions/setup-node@v6
+      - name: Set Github vars
+        run: |
+          if([string]::IsNullOrEmpty('${{ secrets.GIT_USER_NAME }}')){
+            if([string]::IsNullOrEmpty('${{ secrets.GIT_USER_NAME }}')){
+              $gitUser = "action"
+              $gitEmail = "action@github.com"
+            }
+            else {
+              $gitUser = "${GITHUB_ACTOR}"
+              $gitEmail = "$gitUser@users.noreply.github.com"
+            }
+          }
+          else {
+            $gitUser = "${{ secrets.GIT_USER_NAME }}"
+            $gitEmail = "$gitUser@users.noreply.github.com"
+          }
+          git config --global user.email "$gitUser@users.noreply.github.com"
+          git config --global user.name "$gitUser"
+        shell: pwsh     
+      - name: Check if Tag Exists
+        run: |
+          $tagVersion = "${{ inputs.version }}"
+          $tags = git tag
+          echo "Tags found are [$tags], searching for [$tagVersion]"
+          foreach ($tag in $tags)
+          {
+              if($tag.Trim() -eq "$tagVersion")
+              {
+                Write-Error "$tagVersion tag already exists"
+                exit 1
+              }
+          }
+        shell: pwsh
+      - name: Create tag and push
+        run: |
+          $tagVersion = "${{ inputs.version }}"
+          git tag -fa "v$tagVersion" "${GITHUB_SHA}" -m "v$tagVersion Release [skip ci]"
+          git push origin "v$tagVersion" --force       
+        shell: pwsh