Merge pull request #33 from hmcts/update-build

update build to publish after all tests have completed

Author: duncancrawford

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @hmcts/cp-case-administration

.github/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contribution guidelines
+
+We're happy to accept 3rd-party contributions. Please make sure you read this document before you do any work though,
+as we have some expectations related to the content and quality of change sets.
+
+## What you should know about this application
+
+This project is a template Spring Boot application. It aims to speed up the creation of new Spring APIs in HMCTS
+projects, by serving as the initial setup of each API.
+
+## Before contributing
+
+Any ideas on the user journeys and general service experience you may have **should be first consulted
+with us by submitting a new issue** to this repository. Ideas are always welcome, but if something is divergent or unrelated
+to what we're trying to achieve we won't be able to accept it. Please keep this in mind as we don't want to waste anybody's time.
+
+In the interest of creating a friendly collaboration environment, please read and adhere to an open source contributor's
+[code of conduct](http://contributor-covenant.org/version/1/4/).
+
+## Making a contribution
+
+After your idea has been accepted you can implement it. We don't allow direct changes to the codebase from the public,
+they have to go through a review first.
+
+Here's what you should do:
+1. [fork](https://help.github.com/articles/fork-a-repo/) this repository and clone it to your machine,
+2. create a new branch for your change:
+ * use the latest *master* to branch from,
+3. implement the change in your branch:
+ * if the change is non-trivial it's a good practice to split it into several logically independent units and deliver
+   each one as a separate commit,
+ * make sure the commit messages use proper language and accurately describe commit's content, e.g. *"Unify postcode lookup elements spacing"*.
+   More information on good commit messages can be found [here](http://chris.beams.io/posts/git-commit/),
+4. test if your feature works as expected and does not break any existing features, this may include implementing additional automated tests or amending existing ones,
+5. push the change to your GitHub fork,
+6. submit a [pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) to our repository:
+ * ensure that the pull request and related GitHub issue reference each other.
+
+At this point the pull request will wait for someone from our team to review. It may be accepted straight away,
+or we may ask you to make some additional amendments before incorporating it into the main branch.

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,5 @@
+### What would you like to change?
+
+### How do you think that would improve the project?
+
+### If this entry is related to a bug, please provide the steps to reproduce it

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+**Before creating a pull request make sure that:**
+
+- [ ] commit messages are meaningful and follow good commit message guidelines
+- [ ] README and other documentation has been updated / added (if needed)
+- [ ] tests have been updated / new tests has been added (if needed)
+
+Please remove this line and everything above and fill the following sections:
+
+
+### JIRA link (if applicable) ###
+
+
+
+### Change description ###
+
+
+
+**Does this PR introduce a breaking change?** (check one with "x")
+
+```
+[ ] Yes
+[ ] No
+```

.github/workflows/ci-draft.yml

@@ -1,4 +1,4 @@
-name: CI Build and Publish Increments Draft
+name: Build and Publish (DRAFT CANDIDATE VERSION)
 
 on:
   pull_request:
@@ -17,79 +17,94 @@ jobs:
   Artefact-Version:
     runs-on: ubuntu-latest
     outputs:
-      draft_version: ${{ steps.vars.outputs.draft_version }}
-      latest_tag: ${{ steps.vars.outputs.latest_tag }}
+      artefact_version: ${{ steps.artefact.outputs.draft_version }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          fetch-depth: 0 # Necessary to fetch all history for accurate versioning
 
-      #      - name: Show Git tags and commit context (diagnostic/debug)
-      #        run: git tag --list && git log --oneline --decorate
-
-      - name: Get short SHA for versioning
-        id: vars
-        run: |
-          if LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null); then
-            :
-          else
-            LATEST_TAG="v0.0.0"
-          fi
-          echo "🏷️ Latest Git tag resolved to: $LATEST_TAG"
-          LATEST_TAG="${LATEST_TAG#v}"
-          
-          echo "latest_tag=$LATEST_TAG" >> $GITHUB_OUTPUT
-
-          SHORT_SHA=$(git rev-parse --short HEAD)
-          DRAFT_VERSION="${LATEST_TAG}-${SHORT_SHA}"
-
-          echo "draft_version=$DRAFT_VERSION"
-          echo "draft_version=$DRAFT_VERSION" >> $GITHUB_OUTPUT
+      - name: Generate Artefact Version
+        id: artefact
+        uses: hmcts/artefact-version-action@v1
+        with:
+          release: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   Update-Spec-Version:
     needs: [Artefact-Version]
     runs-on: ubuntu-latest
     outputs:
-      openapi_file: ${{ steps.find_spec.outputs.openapi_file }}
+      upload_artifact_name: ${{ steps.update_spec.outputs.upload_artifact_name }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Find OpenAPI file
-        id: find_spec
-        run: |
-          FILE=$(find "${FILE_PATH_OPENAPI}" -name "*.openapi.yml" | head -n 1)
-          if [ -z "$FILE" ]; then
-            echo "⚠️ *** No OpenAPI spec (*.openapi.yml) found. Skipping publishing draft. ***"
-            exit 1
-          fi
-          echo "openapi_file=$FILE" >> $GITHUB_OUTPUT
-
-      - name: Update info.version in OpenAPI spec using yq
-        env:
-          API_NAME: ${{ github.event.repository.name }}
-          API_VERSION: ${{ needs.Artefact-Version.outputs.draft_version }}
-        uses: mikefarah/[email protected]
+      - name: Update OpenAPI Spec Version
+        id: update_spec
+        uses: hmcts/update-openapi-version@main
         with:
-          cmd: |
-            yq '
-              .info.version = strenv(API_VERSION) |
-              .servers[0].url = "https://virtserver.swaggerhub.com/HMCTS-DTS/" + strenv(API_NAME) + "/" + strenv(API_VERSION)
-            ' "${{ steps.find_spec.outputs.openapi_file }}" > openapi-versioned.yml
+          openapi_path: ${{ env.FILE_PATH_OPENAPI }}
+          api_name: ${{ github.event.repository.name }}
+          api_version: ${{ needs.Artefact-Version.outputs.artefact_version }}
+
+  Test:
+    name: Test - Java ${{ matrix.java }}
+    strategy:
+      matrix:
+        java: [17, 21, 23]
+    runs-on: ubuntu-latest
+    needs: [Artefact-Version, Update-Spec-Version]
 
-      - name: Replace original OpenAPI file
-        run: mv openapi-versioned.yml "${{ steps.find_spec.outputs.openapi_file }}"
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
 
-      - name: Upload updated OpenAPI file
-        uses: actions/upload-artifact@v4
+      - name: Set up JDK
+        uses: actions/setup-java@v4
         with:
-          name: updated-openapi-spec
-          path: ${{ steps.find_spec.outputs.openapi_file }}
+          distribution: 'temurin'
+          java-version: ${{ matrix.java }}
 
-  Build:
-    needs: [Artefact-Version, Update-Spec-Version]
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          gradle-version: current
+
+      - name: Download updated OpenAPI file
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ needs.Update-Spec-Version.outputs.upload_artifact_name }}
+          path: ${{ env.FILE_PATH_OPENAPI }}
+
+      - name: Gradle Build
+        env:
+          ARTEFACT_VERSION: ${{ needs.Artefact-Version.outputs.artefact_version }}
+          JAVA_VERSION: ${{ matrix.java }}
+        run: |
+          echo "Building with ARTEFACT_VERSION=$ARTEFACT_VERSION using Java $JAVA_VERSION"
+          gradle build -DAPI_SPEC_VERSION=$ARTEFACT_VERSION
+
+  Push-Draft-OpenAPI-Spec:
+    needs: [ Test ]
+    uses: ./.github/workflows/publish-openapi-spec.yml
+    secrets:
+      SWAGGERHUB_API_KEY: ${{ secrets.APIHUB_API_KEY }}
+    with:
+      upload_artifact_name: ${{ needs.Update-Spec-Version.outputs.upload_artifact_name }}
+      apihub_owner: ${{ vars.APIHUB_ORGANISATION }}
+      api_name: ${{ github.event.repository.name }}
+      api_version: ${{ needs.Artefact-Version.outputs.artefact_version }}
+
+  Publish:
+    name: Publish Artefact - Java ${{ matrix.java }}
+    if: github.event_name == 'push'
     runs-on: ubuntu-latest
+    needs: [Artefact-Version, Push-Draft-OpenAPI-Spec]
+    strategy:
+      matrix:
+        java: [17]
 
     steps:
       - name: Checkout source code
@@ -99,63 +114,31 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: '21'
+          java-version: ${{ matrix.java }}
 
       - name: Set up Gradle
         uses: gradle/actions/setup-gradle@v4
-        with:
-          gradle-version: current
 
       - name: Download updated OpenAPI file
         uses: actions/download-artifact@v4
         with:
-          name: updated-openapi-spec
+          name: ${{ needs.Update-Spec-Version.outputs.upload_artifact_name }}
           path: ${{ env.FILE_PATH_OPENAPI }}
 
-      #      - name: Set Sonar Project Key and Name
-      #        id: sonar_vars
-      #        run: |
-      #          repo_sanitized="${GITHUB_REPOSITORY//\//_}"
-      #          echo "project_key=$repo_sanitized" >> $GITHUB_OUTPUT
-      #          echo "project_name=$repo_sanitized" >> $GITHUB_OUTPUT
-      #
-      #      - name: Analyze with SonarCloud
-      #        uses: SonarSource/[email protected]
-      #        with:
-      #          args: >
-      #            -Dsonar.organization=hmcts
-      #            -Dsonar.projectKey=${{ steps.sonar_vars.outputs.project_key }}
-      #            -Dsonar.projectName=${{ steps.sonar_vars.outputs.project_name }}
-      #            -Dsonar.projectVersion=${{ needs.Artefact-Version.outputs.draft_version }}
-      #            -Dsonar.sources=src
-      #            -Dsonar.java.binaries=build/classes
-      #        env:
-      #          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      #          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-
-      - name: Gradle Build and Publish on Push [Merge]
+      - name: Gradle Publish
         env:
+          ARTEFACT_VERSION: ${{ needs.Artefact-Version.outputs.artefact_version }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           AZURE_DEVOPS_ARTIFACT_USERNAME: ${{ secrets.AZURE_DEVOPS_ARTIFACT_USERNAME }}
           AZURE_DEVOPS_ARTIFACT_TOKEN: ${{ secrets.AZURE_DEVOPS_ARTIFACT_TOKEN }}
+          JAVA_VERSION: ${{ matrix.java }}
         run: |
-          VERSION=${{ needs.Artefact-Version.outputs.draft_version }}
-
-          gradle build \
-            -DAPI_SPEC_VERSION=$VERSION \
+          echo "Publishing artefact for ARTEFACT_VERSION=$ARTEFACT_VERSION using Java $JAVA_VERSION"
+          
+          gradle build -x test publish \
+            -DAPI_SPEC_VERSION=$ARTEFACT_VERSION \
             -DGITHUB_REPOSITORY=${{ github.repository }} \
             -DGITHUB_ACTOR=${{ github.actor }} \
-            -DGITHUB_TOKEN=$GITHUB_TOKEN
-
-          if [ "${{ github.event_name }}" == "push" ]; then
-            echo "Push event trigger - Publishing artefact"
-            gradle publish \
-              -DAPI_SPEC_VERSION=$VERSION \
-              -DGITHUB_REPOSITORY=${{ github.repository }} \
-              -DGITHUB_ACTOR=${{ github.actor }} \
-              -DGITHUB_TOKEN=$GITHUB_TOKEN \
-              -DAZURE_DEVOPS_ARTIFACT_USERNAME=$HMCTS_ARTEFACT_ACTOR \
-              -DAZURE_DEVOPS_ARTIFACT_TOKEN=$AZURE_DEVOPS_ARTIFACT_TOKEN
-          else
-            echo "Skipping publish because this is a pull_request"
-          fi
+            -DGITHUB_TOKEN=$GITHUB_TOKEN \
+            -DAZURE_DEVOPS_ARTIFACT_USERNAME=$AZURE_DEVOPS_ARTIFACT_USERNAME \
+            -DAZURE_DEVOPS_ARTIFACT_TOKEN=$AZURE_DEVOPS_ARTIFACT_TOKEN