feat: merge develop to main

.commitlintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["@commitlint/config-conventional"]
+}

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,28 @@
+---
+name: Bug
+about: An undesirable behaviour that needs correction
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the Bug**
+A clear and concise description of what the bug is.
+
+**Expected Behaviour**
+A clear and concise description of what you expected to happen.
+
+**Actual Behaviour**
+A clear and concise description of what actually happens.
+
+**Implications**
+A clear and concise description of any implications.
+
+**Steps To Reproduce**
+Steps to reproduce the behaviour:
+User/Role:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error

.github/ISSUE_TEMPLATE/spike.md

@@ -0,0 +1,26 @@
+---
+name: Spike
+about: Research options prior to development work
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Problem Description** 
+**In order to** (achieve some goal), (a system or persona) **needs to** (some action).
+
+**Solution Needs**
+- Enter the non-negotiables of the solution (what are the needs vs. what are the wants)
+
+**Timebox**
+- How much effort are we committing to this research?
+
+**Outcome**
+Details describing the outcome of the research 
+- Was it successful? What direction should the work go? 
+- Was it unsuccessful? Discuss next steps with team
+
+**Additional Context**
+- enter text here
+- enter text here

.github/ISSUE_TEMPLATE/task.md

@@ -0,0 +1,23 @@
+---
+name: Task
+about: Any work that does not directly impact the user
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the task**
+A clear and concise description of what the task is.
+
+**Purpose**
+The reason why this task is needed and/or what value it adds.
+
+**Acceptance Criteria**
+- [ ] first
+- [ ] second
+- [ ] third
+
+**Additional context**
+- Add any other context about the task here.
+- Or here

.github/ISSUE_TEMPLATE/user-story.md

@@ -0,0 +1,27 @@
+---
+name: User Story
+about: This template is to be used when describing a feature from the user's perspective
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Description:**
+- [ ] "As a [type of user]" "I want [an action or feature]" "So that [benefit or value]" -
+
+**Wireframe:** <link>
+
+**Purpose and benefit to user:**
+
+**Acceptance Criteria:**
+
+- [ ] Given I am a <role>, When I am <doing something>, then <this happens>
+- [ ] Given I am a <role>, When I am <doing something>, then <this happens>
+
+**Development Checklist:**
+- [ ] A
+- [ ] B
+- [ ] C
+
+**Notes:**

.github/Readme.md

@@ -0,0 +1,76 @@
+# Zeva2 Continuous Delivery Structure
+
+![alt text](CICD-diagram.png)
+
+# Zeva2 Trunk Based Release Model
+
+Learn why this version control management practice is common practice among DevOps teams. https://www.atlassian.com/continuous-delivery/continuous-integration/trunk-based-development
+
+![Here](zeva2-trunk-based-release-model.png)
+
+## Semantic Release
+
+Fully automated version management and package publishing https://github.com/semantic-release/semantic-release
+
+## Conventional Commit
+
+Simple conventional commit messages:
+
+- feat: add export button → Yes (minor release)
+- fix: handle null user → Yes (patch release)
+- perf: optimize search query → Yes (patch release)
+- chore: update dependencies → No
+- docs: update README → No
+- refactor: simplify auth middleware → No
+- test: add user service tests → No
+- ci: adjust release workflow → No
+- build: bump Node version → No
+- style: format lint rules → No
+
+With scopes:
+
+- feat(api): add pagination → Yes (minor release)
+- fix(ui): prevent double submit → Yes (minor release)
+- chore(ci): update GitHub actions → No
+- docs(README): add setup guide → No
+
+Breaking changes:
+
+- feat! : remove legacy endpoint → Yes (major release)
+- refactor(auth)! : change token format → Yes (major release)
+- feat: remove legacy endpoint + BREAKING CHANGE: ... → Yes (major release)
+
+Semantic release commit message (auto generated by semantic release):
+
+- chore(release): 1.2.3 [skip ci] → No (it’s the release commit itself, and [skip ci] prevents CI)
+
+## Husky
+
+A npm package to enforce the conventional commit
+
+## Feature Flag
+
+Use feature flags to disable the unmatured feature on prod release
+
+# Zeva2 Pipelines
+
+## release-dev.yaml
+
+Every commit to main triggers this pipeline. It does the following:
+
+- run the jest test suit
+- based on the conventional commit history, the semantic release process decides if needs to create a release
+- if there is a new release created, build the images on Openshift Tools namespace
+- deploy the images on Openshift Dev environment.
+
+## promote-test.yaml
+
+Manually triggered pipelin to deploy the images to Openshift Test
+
+- provide the image version to be deployed
+- create the pull request with the version changed in CD Repo
+- once the pull request is approved, the version will be deployed on Oepnshift Test environment
+
+## release-prod.yaml
+
+Manually triggered pipelin to deploy the images to Openshift Prod. Same logic as the test deployment.

.github/workflows/build-template.yaml

@@ -0,0 +1,81 @@
+
+# This workfile is a template for building the Zeva2 application in OpenShift.
+# It uses the OpenShift CLI (oc) to process and apply build configurations for the Next.js and BullMQ components of the application.
+# The workflow is triggered by a call from another workflow and requires certain inputs and secrets to be provided.
+name: Build Template
+
+on:
+  workflow_call:
+    inputs:
+      # The git reference to check out the repository
+      git_ref:
+        required: true
+        type: string
+      # The version of the application to build
+      # This is typically set by the GitVersion action in the calling workflow
+      version:
+        required: true
+        type: string
+    secrets:
+      tools-namespace:
+        required: true
+      openshift-server:
+        required: true
+      openshift-token:
+        required: true
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build Zeva2
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4.1.1
+        with:
+          ref: ${{ inputs.git_ref }}
+
+      - name: Restore oc command from Cache
+        uses: actions/cache@v4.2.0
+        with:
+          path: /usr/local/bin/oc
+          key: oc-cli-${{ runner.os }}
+
+      - name: Log in to Openshift
+        uses: redhat-actions/oc-login@v1.3
+        with:
+          openshift_server_url: ${{ secrets.openshift-server }}
+          openshift_token: ${{ secrets.openshift-token }}
+          insecure_skip_tls_verify: true
+          namespace: ${{ secrets.tools-namespace }}
+
+      - name: Build Next
+        run: |
+          echo "VERSION=${{ inputs.version }}"
+          oc projects
+          cd openshift/templates
+          oc process -f ./next-bc.yaml VERSION=${{ inputs.version }} GIT_REF=${{ inputs.git_ref }} | oc apply --wait=true -f - -n ${{ secrets.tools-namespace }}
+          # cancel existing builds if there are any
+          for build in $(oc -n ${{ secrets.tools-namespace }} get builds -l buildconfig=zeva2-next-${{ inputs.version }} -o jsonpath='{.items[?(@.status.phase=="Running")].metadata.name}'); do
+            echo "canceling $build"
+            oc -n ${{ secrets.tools-namespace }} cancel-build $build
+          done          
+          oc -n ${{ secrets.tools-namespace }} start-build zeva2-next-${{ inputs.version }} --wait=true
+
+      - name: Build Bullmq
+        run: |
+          echo "VERSION=${{ inputs.version }}"
+          oc projects
+          cd openshift/templates
+          oc process -f ./bullmq-bc.yaml VERSION=${{ inputs.version }} GIT_REF=${{ inputs.git_ref }} | oc apply --wait=true -f - -n ${{ secrets.tools-namespace }}
+          # cancel existing builds if there are any
+          for build in $(oc -n ${{ secrets.tools-namespace }} get builds -l buildconfig=zeva2-bullmq-${{ inputs.version }} -o jsonpath='{.items[?(@.status.phase=="Running")].metadata.name}'); do
+            echo "canceling $build"
+            oc -n ${{ secrets.tools-namespace }} cancel-build $build
+          done               
+          oc -n ${{ secrets.tools-namespace }} start-build zeva2-bullmq-${{ inputs.version }} --wait=true
+

.github/workflows/cron-cleanup-workflow-runs.yaml

@@ -0,0 +1,25 @@
+# This workflow is triggered on a schedule and manually to delete old workflow runs.
+# It uses the Mattraks/delete-workflow-runs action to delete workflow runs older than 5 days,
+# while keeping a minimum of 10 runs.
+name: Cleanup Workflow Runs
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 8 * * *"
+
+permissions:
+  contents: read
+
+jobs:
+  del_runs:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write
+    steps:
+      - name: Delete workflow runs
+        uses: Mattraks/delete-workflow-runs@v2.0.6
+        with:
+          token: ${{ github.token }}
+          repository: ${{ github.repository }}
+          retain_days: 5
+          keep_minimum_runs: 10