README improvements + CI unit test naming changes

Author: tsviz

.github/workflows/ci.yml

@@ -102,11 +102,11 @@ jobs:
           name: jar-artifact # naming the artifact jar file/s path
           path: target/ # actual relative path to the artifact in the container - target/
 
-  uat-parallel-tests:
-    # uat-parallel-tests job will run on ubuntu-latest github-hosted runner
-    name: UAT
+  unit-parallel-tests:
+    # unit-parallel-tests job will run on ubuntu-latest github-hosted runner
+    name: UNIT-PARALLEL-TESTS
     runs-on: ubuntu-latest
-    needs: # needs build job and runner-indexes job to be completed before running the uat-parallel-tests job
+    needs: # needs build job and runner-indexes job to be completed before running the unit-parallel-tests job
       - build
       - runner-indexes
     container:
@@ -191,15 +191,15 @@ jobs:
 
   build-and-publish-docker-image: # job to build the docker image and publish it to the GitHub Container Registry
     runs-on: ubuntu-latest # using the latest ubuntu runner
-    needs: [build, uat-parallel-tests] # this job needs build and uat-parallel-tests jobs as a requirement to run
+    needs: [build, unit-parallel-tests] # this job needs build and unit-parallel-tests jobs as a requirement to run
     if: github.ref == 'refs/heads/main' # run this job only when the branch is main branch and not on pull requests or other branches - https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context
     # permissions for write acces to the packages and id-token and push access to the repository to create the container registry token
     permissions:
       packages: write
       id-token: write
       contents: write
 
-    # steps to run the uat-parallel-tests job are as follows:
+    # steps to run the unit-parallel-tests job are as follows:
     # 1. checkout the repository
     # 2. download the jar artifact from the build job
     # 3. use the docker layer caching action to speed up the docker image build process
@@ -232,7 +232,7 @@ jobs:
           cache-from: type=registry,ref=ghcr.io/${{ github.repository }}:latest # use the docker layer caching to speed up the docker image build process
           cache-to: type=inline
 
-  runner-indexes: # job to generate the runner indexes for the uat-parallel-tests job
+  runner-indexes: # job to generate the runner indexes for the unit-parallel-tests job
     runs-on: ubuntu-latest
     name: Generate runner indexes
     outputs:

README.md

@@ -1,6 +1,97 @@
-## Springboot app with Liquibase and Oracle Database
-This is a Maven project that demos how to run a Spring application in CircleCI/CD with the [Liquibase spring integration](https://www.liquibase.org/javadoc/liquibase/integration/spring/SpringLiquibase.html) and the Liquibase [Maven Plugin](https://docs.liquibase.com/tools-integrations/maven/home.html).
+# Java Demo App
 
-## GitHub Actions or CircleCI Workflows
-1. The workflow will first run [Quality Checks](https://www.liquibase.com/quality-checks) using the Liquibase [Maven Plugin](https://docs.liquibase.com/tools-integrations/maven/home.html).
-2. If the Quality Checks run successfully, the workflow will then build the application.  That will include running the database changes with [Liquibase spring integration](https://www.liquibase.org/javadoc/liquibase/integration/spring/SpringLiquibase.html) and packaging the application code (compiling, running unit tests and generating artifacts).
+**The App**
+
+This is a simple Sales Manager Java App that stores sales items in a table presented in a web app.
+
+This demo repo is designed to help understand some of **CI/CD** (Continuous Integration/Continuous Delivery) principles and best practices.
+
+**The Settings**
+
+**Java** (Spring Boot framework) with **MVC** (Model View Controller) and **OOP** (Object Oriented Programming) design patterns.
+ 
+ *CI/CD Pipeline*
+ [GitHub Actions](https://docs.github.com/en/enterprise-cloud@latest/actions) as the main CI/CD pipeline orchestrator
+Tools used to optimize the pipeline (See the `.github/workflows/ci.yml` for more detailed configuration).
+
+ - [Caching Dependencies to Speed Up Workflows](https://docs.github.com/en/enterprise-cloud@latest/actions/using-workflows/caching-dependencies-to-speed-up-workflows)
+ - [Using the Metrix Strategy to Run Unit Tests In Parallel](https://docs.github.com/en/enterprise-cloud@latest/actions/using-jobs/using-a-matrix-for-your-jobs)
+              
+# CI/CD Diagram
+```mermaid
+stateDiagram
+    state Continuous-Integration {
+    Commits --> PR: Developers Commit new changes in a Pull Request
+    PR --> CI: Security Scans, Build & Unit Test Suit
+    CI --> PR: Feedback of failed tests - back to dev
+    CI --> Publish: If CI passes, \nmerging to main branch \nand publishing Containerised\n App to GHCR
+    }
+    
+    state Parallel-Testing {
+        CI --> JunitTest1
+        CI --> JunitTest2
+        CI --> JunitTest3
+        CI --> JunitTest..N
+    }
+    
+    state Continuous-Delivery {
+    Publish --> PreProdTests: Pulling Image from GHDR
+    PreProdTests --> Deploy: Deploy the app to K8s
+    }
+```
+
+# Gitgraph Diagram - Developer Workflow
+```mermaid
+%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true}} }%%
+      gitGraph
+        commit
+        branch hotfix
+        checkout hotfix
+        commit
+        branch develop
+        checkout develop
+        commit id:"ash" tag:"abc"
+        branch featureB
+        checkout featureB
+        commit type:HIGHLIGHT
+        checkout main
+        checkout hotfix
+        commit type:NORMAL
+        checkout develop
+        commit type:REVERSE
+        checkout featureB
+        commit
+        checkout main
+        merge hotfix
+        checkout featureB
+        commit
+        checkout develop
+        branch featureA
+        commit
+        checkout develop
+        merge hotfix
+        checkout featureA
+        commit
+        checkout featureB
+        commit
+        checkout develop
+        merge featureA
+        branch release
+        checkout release
+        commit
+        checkout main
+        commit
+        checkout release
+        merge main
+        checkout develop
+        merge release
+```
+
+ *Building and Testing*
+ - [Maven](https://maven.apache.org/) as the project management for Building and Testing the application.
+
+
+User input data is stored in an Oracle (PDB) Database.
+
+
+For easy demos, an H2 database (Oracle Mode) is setup by default in the `src/main/resources/application.properties` file.