@benefex/icons 0.7.1 → 0.8.0

package/README.md

@@ -8,29 +8,31 @@ SVGs are automatically converted to TSX using [svgr](https://react-svgr.com/)
 - Make sure it has `fill="currentColor` or `stroke="currentColor"`
 - Make sure it has a viewBox (width, height will be removed)
 
-### Publishing
-
-All version deployments are handled by circleCI. To begin developing a new version you will need to create a branch.
-
-Use [`npm version`](https://docs.npmjs.com/cli/version) with the feature branch checked out to create a new version commit. This will automatically update the version number in `package.json` and other relevant files. Code is linted and tested before a version is created.
-
-Use [semantic versioning](https://semver.org) where possible:
-
+### Versioning
+Use [semantic versioning](https://semver.org):
 - `major` version when you make incompatible API changes
 - `minor` version when you add functionality in a backwards-compatible manner
 - `patch` version when you make backwards-compatible bug fixes
 
-```bash
-git checkout -b branchname
-npm version patch # patch/minor/major
-git push
-```
+All latest version deployments are handled by [semantic-release](https://github.com/semantic-release/semantic-release) which is triggered in CircleCI's `main` pipeline. _semantic-release_ will look at your commit message and determine how to increment the version based on its format. See [here](https://github.com/TrigenSoftware/simple-release/blob/main/GUIDE.md) for more details on how this works. [commitlint](https://commitlint.js.org/) hook is used to ensure your commit message is correct before pushing.
+  
+To summarise:
+- `feat` is a minor version bump
+- `fix` is a patch version bump
+- `perf` is a patch version bump
+- commit with `!` after the type (or scope) is a major version bump. Eg: `feat!: add image` or `feat(new)!: add image`
+- all other types do not cause any version bump
+
+_*This is fully customizable so can be updated to better suit our needs if required_
 
-Once a version has been pushed a PR needs to be opened for circleCI to trigger a build. There is no need to manage beta tags as this is done by circleCI.
+When the pull request is merged to main, the CircleCI main workflow runs which will perform all of the necessary npm publishing and git tagging, along with creating a Github release containing release notes.
 
-Any build deployed from a branch will be deployed as `1.0.0-beta.0` (1.0.0 being the version number that is defined in `package.json`)with the last value automatically incrementing.
+#### Beta deployments 
+All pull requests will deploy a beta version as part of the PR pipeline. This allows for easy testing without having to merge your PR. The version deployed will be `{CURRENT_MAJOR_VERSION}.0.0-PR${PULL_REQUEST_NUMBER}-BN${BUILD_NUM}`. For example: `7.0.0-PR100-BN150`
 
-The Pull Request should then be merged to main with final CircleCI workflow running, this will perform all of the npm publishing and git tagging that is required.
+#### Check the version your branch is using
+We do not keep track of the current version in package.json due to it not being necessary ([Why isn't it necessary?](https://semantic-release.gitbook.io/semantic-release/support/faq#it-is-not-needed-for-semantic-release-to-do-its-job)).
+However, to print out the package version your branch is using, run `npm run check-version`
 
 ## Usage
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@benefex/icons",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "Benefex icon package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,6 +10,7 @@
   ],
   "scripts": {
     "test": "npx jest --coverage",
+    "ci-test": "CI=true npm test -- --coverage --ci --runInBand",
     "lint": "echo 'No linting'",
     "clean": "rm -rf ./generated && rm -rf ./dist",
     "build:icons": "npx @svgr/cli --out-dir generated ./src/svgs/ && cp src/svgr.ts generated",
@@ -17,7 +18,14 @@
     "build": "npm run clean && npm run build:icons && npm run build:tsc",
     "prepublishOnly": "npm run build",
     "storybook": "npm run build && storybook dev -p 6006",
-    "build-storybook": "npm run build && storybook build"
+    "build-storybook": "npm run build && storybook build",
+    "prepare": "husky",
+    "check-version": "git fetch --tags && git describe --tags --abbrev=0"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
   },
   "repository": {
     "type": "git",
@@ -34,6 +42,8 @@
   },
   "homepage": "https://github.com/BenefexLtd/onehub-icons#readme",
   "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
     "@storybook/addon-essentials": "^8.1.10",
     "@storybook/addon-links": "^8.1.10",
     "@storybook/blocks": "^8.1.10",
@@ -43,6 +53,7 @@
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "camelcase": "^8.0.0",
+    "husky": "^9.1.6",
     "jest": "^29.7.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
@@ -51,5 +62,8 @@
   },
   "peerDependencies": {
     "react": "16 - 18"
+  },
+  "dependencies": {
+    "conventional-changelog-conventionalcommits": "^9.1.0"
   }
 }