From ee9dd58e16db4958526f80e1c6f4faa30145b600 Mon Sep 17 00:00:00 2001 From: Arkadyuti Bandyopadhyay Date: Sun, 20 Apr 2025 01:14:03 +0530 Subject: [PATCH 1/6] Made file changes for commit linting --- .github/workflows/commitlint.yml | 30 ++++++++++++++++++++++++++++++ .gitignore | 3 +++ .husky/commit-msg | 4 ++++ .husky/pre-commit | 4 ++++ commitlint.config.js | 3 +++ package.json | 15 +++++++++++++++ pom.xml | 18 ++++++++++++++++++ 7 files changed, 77 insertions(+) create mode 100644 .github/workflows/commitlint.yml create mode 100644 .husky/commit-msg create mode 100644 .husky/pre-commit create mode 100644 commitlint.config.js create mode 100644 package.json diff --git a/.github/workflows/commitlint.yml b/.github/workflows/commitlint.yml new file mode 100644 index 00000000..f752ce46 --- /dev/null +++ b/.github/workflows/commitlint.yml @@ -0,0 +1,30 @@ +name: Commit Compliance + +on: + pull_request: + types: [opened, synchronize, reopened] + +jobs: + commitlint: + runs-on: ubuntu-latest + + steps: + - name: Take latest code + 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: Install Node + uses: actions/setup-node@v4 + with: + node-version: 18 + + - name: Install dependencies + run: npm ci + + - name: Run commitlint on PR + run: | + npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose \ No newline at end of file diff --git a/.gitignore b/.gitignore index b93dcb79..486db5e7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,9 @@ target/ !.mvn/wrapper/maven-wrapper.jar +node_modules +package-lock.json + ### STS ### .apt_generated .classpath diff --git a/.husky/commit-msg b/.husky/commit-msg new file mode 100644 index 00000000..95a96097 --- /dev/null +++ b/.husky/commit-msg @@ -0,0 +1,4 @@ +#!/bin/sh +. "$(dirname "$0")/_/husky.sh" + +npx --no -- commitlint --edit "$1" \ No newline at end of file diff --git a/.husky/pre-commit b/.husky/pre-commit new file mode 100644 index 00000000..fb41ef6e --- /dev/null +++ b/.husky/pre-commit @@ -0,0 +1,4 @@ +#!/bin/sh +. "$(dirname "$0")/_/husky.sh" + +mvn spotless:check || exit 1 \ No newline at end of file diff --git a/commitlint.config.js b/commitlint.config.js new file mode 100644 index 00000000..ed123736 --- /dev/null +++ b/commitlint.config.js @@ -0,0 +1,3 @@ +module.exports = { + extends: ['@commitlint/config-conventional'] +}; \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 00000000..1e4cd43e --- /dev/null +++ b/package.json @@ -0,0 +1,15 @@ +{ + "name": "inventory-api", + "version": "1.0.0", + "description": "[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) ![branch parameter](https://github.com/PSMRI/Inventory-API/actions/workflows/sast-and-package.yml/badge.svg)", + "scripts": { + "prepare": "husky install" + }, + "license": "GPL-3.0-or-later", + "devDependencies": { + "@commitlint/cli": "^19.8.0", + "@commitlint/config-conventional": "^19.8.0", + "commitizen": "^4.3.1", + "husky": "^9.1.7" + } +} diff --git a/pom.xml b/pom.xml index 14079e6b..0573f83d 100644 --- a/pom.xml +++ b/pom.xml @@ -272,6 +272,24 @@ Inventoryapi-v3.0.0 + + com.diffplug.spotless + spotless-maven-plugin + 2.44.0 + + + + check + apply + + + + + + + + + org.owasp dependency-check-maven From 635faed0e8ce93bb316c155115e5d7e671d04a7b Mon Sep 17 00:00:00 2001 From: Arkadyuti Bandyopadhyay Date: Sun, 20 Apr 2025 01:24:52 +0530 Subject: [PATCH 2/6] fix:Added rules --- commitlint.config.js | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/commitlint.config.js b/commitlint.config.js index ed123736..2f559abe 100644 --- a/commitlint.config.js +++ b/commitlint.config.js @@ -1,3 +1,23 @@ module.exports = { - extends: ['@commitlint/config-conventional'] + extends: ['@commitlint/config-conventional'], + rules: { + 'header-max-length': [2, 'always', 72], + 'subject-case': [2, 'always', 'sentence-case'], + 'subject-empty': [2, 'never'], + 'subject-full-stop': [2, 'never'], + 'type-enum': [ + 2, + 'always', + ['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'chore', 'ci', 'build'], + ], + 'type-case': [2, 'always', 'lower-case'], + 'type-empty': [2, 'never'], + 'body-leading-blank': [2, 'always'], + 'body-max-line-length': [2, 'always', 72], + 'footer-leading-blank': [2, 'always'], + 'footer-max-line-length': [2, 'always', 72], + 'footer-empty': [2, 'never'], + 'breakline-before-body': [2, 'always'], + 'breaking-change': [2, 'always'], + }, }; \ No newline at end of file From c9815899072617f817ad15f5b83e50708a2b1247 Mon Sep 17 00:00:00 2001 From: Arkadyuti Bandyopadhyay Date: Sun, 20 Apr 2025 01:47:17 +0530 Subject: [PATCH 3/6] bad commit --- commitlint.config.js | 49 ++++++++++++++++++++++++++++---------------- package.json | 9 +++++++- 2 files changed, 39 insertions(+), 19 deletions(-) diff --git a/commitlint.config.js b/commitlint.config.js index 2f559abe..e65d7e68 100644 --- a/commitlint.config.js +++ b/commitlint.config.js @@ -1,23 +1,36 @@ module.exports = { extends: ['@commitlint/config-conventional'], rules: { - 'header-max-length': [2, 'always', 72], - 'subject-case': [2, 'always', 'sentence-case'], - 'subject-empty': [2, 'never'], - 'subject-full-stop': [2, 'never'], - 'type-enum': [ - 2, - 'always', - ['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'chore', 'ci', 'build'], + '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', ], - 'type-case': [2, 'always', 'lower-case'], - 'type-empty': [2, 'never'], - 'body-leading-blank': [2, 'always'], - 'body-max-line-length': [2, 'always', 72], - 'footer-leading-blank': [2, 'always'], - 'footer-max-line-length': [2, 'always', 72], - 'footer-empty': [2, 'never'], - 'breakline-before-body': [2, 'always'], - 'breaking-change': [2, 'always'], - }, + ], + } }; \ No newline at end of file diff --git a/package.json b/package.json index 1e4cd43e..3ab12546 100644 --- a/package.json +++ b/package.json @@ -3,13 +3,20 @@ "version": "1.0.0", "description": "[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) ![branch parameter](https://github.com/PSMRI/Inventory-API/actions/workflows/sast-and-package.yml/badge.svg)", "scripts": { - "prepare": "husky install" + "prepare": "husky", + "commit": "cz", + "config": { + "commitizen": { + "path": "./node_modules/cz-conventional-changelog" + } + } }, "license": "GPL-3.0-or-later", "devDependencies": { "@commitlint/cli": "^19.8.0", "@commitlint/config-conventional": "^19.8.0", "commitizen": "^4.3.1", + "cz-conventional-changelog": "^3.3.0", "husky": "^9.1.7" } } From 90c6fa45cbc0cd78d68b11e742e1ea24c39adbab Mon Sep 17 00:00:00 2001 From: Arkadyuti Bandyopadhyay Date: Sun, 20 Apr 2025 02:14:35 +0530 Subject: [PATCH 4/6] fix: removed pre-commit msg and changed commitzen config --- .husky/commit-msg | 3 --- .husky/pre-commit | 4 ---- package.json | 12 ++++++------ pom.xml | 18 ------------------ 4 files changed, 6 insertions(+), 31 deletions(-) delete mode 100644 .husky/pre-commit diff --git a/.husky/commit-msg b/.husky/commit-msg index 95a96097..990bd0b7 100644 --- a/.husky/commit-msg +++ b/.husky/commit-msg @@ -1,4 +1 @@ -#!/bin/sh -. "$(dirname "$0")/_/husky.sh" - npx --no -- commitlint --edit "$1" \ No newline at end of file diff --git a/.husky/pre-commit b/.husky/pre-commit deleted file mode 100644 index fb41ef6e..00000000 --- a/.husky/pre-commit +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/sh -. "$(dirname "$0")/_/husky.sh" - -mvn spotless:check || exit 1 \ No newline at end of file diff --git a/package.json b/package.json index 3ab12546..a05b206a 100644 --- a/package.json +++ b/package.json @@ -4,12 +4,7 @@ "description": "[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) ![branch parameter](https://github.com/PSMRI/Inventory-API/actions/workflows/sast-and-package.yml/badge.svg)", "scripts": { "prepare": "husky", - "commit": "cz", - "config": { - "commitizen": { - "path": "./node_modules/cz-conventional-changelog" - } - } + "commit": "cz" }, "license": "GPL-3.0-or-later", "devDependencies": { @@ -18,5 +13,10 @@ "commitizen": "^4.3.1", "cz-conventional-changelog": "^3.3.0", "husky": "^9.1.7" + }, + "config": { + "commitizen": { + "path": "./node_modules/cz-conventional-changelog" + } } } diff --git a/pom.xml b/pom.xml index 0573f83d..14079e6b 100644 --- a/pom.xml +++ b/pom.xml @@ -272,24 +272,6 @@ Inventoryapi-v3.0.0 - - com.diffplug.spotless - spotless-maven-plugin - 2.44.0 - - - - check - apply - - - - - - - - - org.owasp dependency-check-maven From 02354ec9e801a21d6eb1edf64c87833e5a693c94 Mon Sep 17 00:00:00 2001 From: Arkadyuti Bandyopadhyay Date: Sun, 20 Apr 2025 12:43:02 +0530 Subject: [PATCH 5/6] fix: change Github actions setup --- .github/workflows/commitlint.yml | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/commitlint.yml b/.github/workflows/commitlint.yml index f752ce46..91844e4d 100644 --- a/.github/workflows/commitlint.yml +++ b/.github/workflows/commitlint.yml @@ -23,7 +23,7 @@ jobs: node-version: 18 - name: Install dependencies - run: npm ci + run: npm ci --legacy-peer-deps - name: Run commitlint on PR run: | diff --git a/package.json b/package.json index a05b206a..d4d97edf 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "version": "1.0.0", "description": "[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) ![branch parameter](https://github.com/PSMRI/Inventory-API/actions/workflows/sast-and-package.yml/badge.svg)", "scripts": { - "prepare": "husky", + "prepare": "husky install", "commit": "cz" }, "license": "GPL-3.0-or-later", From b7feefea644d4fdb5082220e9b62b52373e57b37 Mon Sep 17 00:00:00 2001 From: Arkadyuti Bandyopadhyay Date: Sun, 20 Apr 2025 12:45:16 +0530 Subject: [PATCH 6/6] fix: reverted husky command change --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index d4d97edf..a05b206a 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "version": "1.0.0", "description": "[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) ![branch parameter](https://github.com/PSMRI/Inventory-API/actions/workflows/sast-and-package.yml/badge.svg)", "scripts": { - "prepare": "husky install", + "prepare": "husky", "commit": "cz" }, "license": "GPL-3.0-or-later",