Feat/commitlint setup

.git-hooks/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+set -e
+
+npx --yes @commitlint/cli@20.4.3 --edit "$1"

.github/workflows/commit-lint.yml

@@ -1,35 +1,31 @@
-name: Commit Compliance
+name: Commit Message Check
 
 on:
   pull_request:
     types: [opened, synchronize, reopened]
 
 jobs:
-  commitlint:
+  commit-check:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout code with submodule
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
         with:
-          ref: ${{ github.event.pull_request.head.ref }}
-          repository: ${{ github.event.pull_request.head.repo.full_name }}
-          submodules: true
           fetch-depth: 0
 
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: '20'
 
-      - name: Install dependencies
+      - name: Validate commit messages
         run: |
-          npm ci --legacy-peer-deps
-          npm i --legacy-peer-deps
-
-      - name: Run commitlint on PR
-        run: |
-          npx commitlint --from ${{ github.event.pull_request.base.sha }} \
-            --to ${{ github.event.pull_request.head.sha }} \
-            --verbose
-
+          set -eo pipefail
+          commits=$(git log --no-merges --pretty=format:"%H" "${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}")
+          if [ -z "$commits" ]; then
+            echo "No commits to validate"
+            exit 0
+          fi
+          for sha in $commits; do
+            echo "Validating commit $sha"
+            git log -1 --pretty=format:"%B" "$sha" | npx --yes @commitlint/cli@20.4.3
+          done

README.md

@@ -18,66 +18,26 @@ This microservice is built on Java, Spring boot framework and MySQL DB.
 * Redis
 * MySQL Database
 * Maven
+* Node.js
 
 ### Installation and setup
 
 To install the MMU module, please follow these steps:
 
 1. Clone the repository to your local machine.
-2. Install the dependencies and build the module:
+2. Enable git hooks (run once after cloning):
+   - Run the command `git config core.hooksPath .git-hooks`.
+3. Install the dependencies and build the module:
     - Run the command `mvn clean install`.
-3. You can copy `common_example.properties` to `common_local.properties` and edit the file accordingly. The file is under `src/main/environment` folder.
-4. Run the development server:
+4. You can copy `common_example.properties` to `common_local.properties` and edit the file accordingly. The file is under `src/main/environment` folder.
+5. Run the development server:
     - Start the Redis server.
     - Run the command `mvn spring-boot:run -DENV_VAR=local`.
-5. Open your browser and access `http://localhost:8080/swagger-ui.html#!/` to view the Swagger API documentation.
+6. Open your browser and access `http://localhost:8080/swagger-ui.html#!/` to view the Swagger API documentation.
 
 ## Usage
 All features have been exposed as REST endpoints. Refer to the SWAGGER API specification for details.
 
-## Setting Up Commit Hooks
-
-This project uses Git hooks to enforce consistent code quality and commit message standards. Even though this is a Java project, the hooks are powered by Node.js. Follow these steps to set up the hooks locally:
-
-### Prerequisites
-- Node.js (v14 or later)
-- npm (comes with Node.js)
-
-### Setup Steps
-
-1. **Install Node.js and npm**
-   - Download and install from [nodejs.org](https://nodejs.org/)
-   - Verify installation with:
-     ```
-     node --version
-     npm --version
-     ```
-2. **Install dependencies**
-   - From the project root directory, run:
-     ```
-     npm ci
-     ```
-   - This will install all required dependencies including Husky and commitlint
-3. **Verify hooks installation**
-   - The hooks should be automatically installed by Husky
-   - You can verify by checking if the `.husky` directory contains executable hooks
-### Commit Message Convention
-This project follows a specific commit message format:
-- Format: `type(scope): subject`
-- Example: `feat(login): add remember me functionality`
-Types include:
-- `feat`: A new feature
-- `fix`: A bug fix
-- `docs`: Documentation changes
-- `style`: Code style changes (formatting, etc.)
-- `refactor`: Code changes that neither fix bugs nor add features
-- `perf`: Performance improvements
-- `test`: Adding or fixing tests
-- `build`: Changes to build process or tools
-- `ci`: Changes to CI configuration
-- `chore`: Other changes (e.g., maintenance tasks, dependencies)
-Your commit messages will be automatically validated when you commit, ensuring project consistency.
-
 ## Filing Issues
 
 If you encounter any issues, bugs, or have feature requests, please file them in the [main AMRIT repository](https://github.com/PSMRI/AMRIT/issues). Centralizing all feedback helps us streamline improvements and address concerns efficiently.  

commitlint.config.js

@@ -1,36 +1,35 @@
 module.exports = {
-    extends: ['@commitlint/config-conventional'],
-    rules: {
-      'body-leading-blank': [1, 'always'],
-      'body-max-line-length': [2, 'always', 100],
-      'footer-leading-blank': [1, 'always'],
-      'footer-max-line-length': [2, 'always', 100],
-      'header-max-length': [2, 'always', 100],
-      'subject-case': [
-        2,
-        'never',
-        ['sentence-case', 'start-case', 'pascal-case', 'upper-case'],
+  rules: {
+    'body-leading-blank': [1, 'always'],
+    'body-max-line-length': [2, 'always', 100],
+    'footer-leading-blank': [1, 'always'],
+    'footer-max-line-length': [2, 'always', 100],
+    'header-max-length': [2, 'always', 100],
+    'subject-case': [
+      2,
+      'never',
+      ['sentence-case', 'start-case', 'pascal-case', 'upper-case'],
+    ],
+    'subject-empty': [2, 'never'],
+    'subject-full-stop': [2, 'never', '.'],
+    'type-case': [2, 'always', 'lower-case'],
+    'type-empty': [2, 'never'],
+    'type-enum': [
+      2,
+      'always',
+      [
+        'build',
+        'chore',
+        'ci',
+        'docs',
+        'feat',
+        'fix',
+        'perf',
+        'refactor',
+        'revert',
+        'style',
+        'test',
       ],
-      'subject-empty': [2, 'never'],
-      'subject-full-stop': [2, 'never', '.'],
-      'type-case': [2, 'always', 'lower-case'],
-      'type-empty': [2, 'never'],
-      'type-enum': [
-        2,
-        'always',
-        [
-          'build',
-          'chore',
-          'ci',
-          'docs',
-          'feat',
-          'fix',
-          'perf',
-          'refactor',
-          'revert',
-          'style',
-          'test'
-        ],
-      ],
-    },
-  };
+    ],
+  },
+};