diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b35638a..9ac13dc 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -45,6 +45,22 @@ $ npx gulp dev After debugging, run the command `npx gulp` (without any argument) will automatically output the compressed files to the directory `assets/js/dist/`. +## Verify the commit messages + +If you want to make sure your commits pass the CI check, you can refer to the following steps. + +Install `commitlint` & `husky`: + +```console +$ npm i -g @commitlint/{cli,config-conventional} husky +``` + +And then enable `husky`: + +```console +$ husky install +``` + --- :tada: Your volunteering will make the open-source world more beautiful, thanks again! :tada: diff --git a/.husky/commit-msg b/.husky/commit-msg index 7fed485..4037788 100755 --- a/.husky/commit-msg +++ b/.husky/commit-msg @@ -1,4 +1,4 @@ #!/bin/sh . "$(dirname "$0")/_/husky.sh" -npx --no -- commitlint --edit +npx --no -- commitlint -x $(npm root -g)/@commitlint/config-conventional --edit diff --git a/.versionrc.json b/.versionrc.json new file mode 100644 index 0000000..4b880d3 --- /dev/null +++ b/.versionrc.json @@ -0,0 +1,20 @@ +{ + "skip": { + "commit": true, + "tag": true + }, + "types": [ + { + "type": "feat", + "section": "Features" + }, + { + "type": "fix", + "section": "Bug Fixes" + }, + { + "type": "perf", + "section": "Improvements" + } + ] +} diff --git a/package.json b/package.json index a17cfe9..ad98e6a 100644 --- a/package.json +++ b/package.json @@ -12,43 +12,12 @@ "url": "https://github.com/cotes2020/jekyll-theme-chirpy/issues" }, "homepage": "https://github.com/cotes2020/jekyll-theme-chirpy#readme", - "scripts": { - "prepare": "husky install" - }, "devDependencies": { - "@commitlint/cli": "^16.2.1", - "@commitlint/config-conventional": "^16.2.1", "gulp": "^4.0.2", "gulp-concat": "^2.6.1", "gulp-insert": "^0.5.0", "gulp-rename": "^2.0.0", "gulp-uglify": "^3.0.2", - "husky": "^7.0.4", - "standard-version": "^9.3.2", "uglify-js": "^3.14.3" - }, - "commitlint": { - "extends": [ - "@commitlint/config-conventional" - ] - }, - "standard-version": { - "skip": { - "commit": true, - "tag": true - }, - "types": [{ - "type": "feat", - "section": "Features" - }, - { - "type": "fix", - "section": "Bug Fixes" - }, - { - "type": "perf", - "section": "Improvements" - } - ] } } diff --git a/tools/release.sh b/tools/release.sh index 99e462e..2b55218 100755 --- a/tools/release.sh +++ b/tools/release.sh @@ -10,7 +10,7 @@ # # Usage: run on main branch or the patch branch # -# Requires: Git, Node.js, NPX and RubyGems +# Requires: Git, NPM and RubyGems set -eu @@ -36,7 +36,7 @@ FILES=( TOOLS=( "git" "npm" - "npx" + "standard-version" "gem" ) @@ -143,9 +143,9 @@ resume_config() { # auto-generate a new version number to the file 'package.json' standard_version() { if $opt_pre; then - npx standard-version --prerelease rc + standard-version --prerelease rc else - npx standard-version + standard-version fi }