Merge pull request #3 from 92green/release/2

Release/2

.husky/pre-push

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+echo -e "===\n>> Pre-push Hook: Checking branch name..."
+
+BRANCH=`git rev-parse --abbrev-ref HEAD`
+PROTECTED_BRANCHES="^(auto-release)"
+
+if [[ "$BRANCH" =~ $PROTECTED_BRANCHES ]]
+then
+  echo -e "\n🚫 Cannot push to remote $BRANCH branch, please create your own branch and use PR." && exit 1
+fi
+
+echo -e ">> Finish checking branch name..."
+
+exit 0

CHANGELOG.md

@@ -1,5 +1,25 @@
 
 
+## [0.2.0-0](https://github.com/92green/reusable-regex/compare/0.1.0-4...0.2.0-0) (2023-09-20)
+
+
+### Features
+
+* make pre-push an executable ([a2d8133](https://github.com/92green/reusable-regex/commit/a2d8133a3c8436715527ab0fef5c5ae979e20b51))
+
+
+### Bug Fixes
+
+* fixed package version in lock file ([095b60a](https://github.com/92green/reusable-regex/commit/095b60a73d9b12d05e26e61fe9f823468caea6bb))
+* fixed version number ([180a837](https://github.com/92green/reusable-regex/commit/180a837b5e48792f5e2ee532396dc584b629dabb))
+* package.json version field ([f470a73](https://github.com/92green/reusable-regex/commit/f470a73cf927a5c50b329a451df3900414c8aaae))
+
+
+### Maintenance
+
+* documentation ([cabae01](https://github.com/92green/reusable-regex/commit/cabae0189006dad5da4e9fd695b7cfeb7dae45fe))
+* prevent pushes to auto-release (locally) ([4f3d870](https://github.com/92green/reusable-regex/commit/4f3d8706da517389baf0cdfbb87f00662c04ea80))
+
 ## [0.1.0-4](https://github.com/92green/reusable-regex/compare/0.1.0-3...0.1.0-4) (2023-09-18)
 
 

README.md

@@ -2,9 +2,37 @@
 
 A bunch of entertaining regex to validate your strings against.
 
+## Installation
+
+```
+npm i @92green/possum-regexes
+```
+
+```
+yarn add @92green/possum-regexes
+```
+
 ## Usage example
 
 ```js
 import {HEX_COLOUR_CODE_REGEX} from '@92green/possum-regexes';
 const isHexValid = HEX_COLOUR_CODE_REGEX.test("#f2f2f2")
 ```
+
+## Important - Commit guidelines
+
+Commit style adheres to commitlint and is integrated closely with `release-it`
+meaning 
+
+- `feat!:` results in a breaking change and major version bump
+- `feat:`  results in the minor being automatically bumped
+- `fix:` results in the patch version being automatically bumped
+
+Please be mindful of your commit messages as **they will show up** in auto-generated CHANGELOG.md
+
+## Automatic releases
+
+Automatic releases have been configured in github workflows, and as such;
+
+- targetting `release/*` branch will trigger an automated prerelease package publish
+- targetting `auto-release` branch will trigger a package release publish

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@92green/reusable-regex",
-    "version": "1.0.0",
+    "version": "0.2.0-0",
     "description": "Resuable regexes for blueflag projects.",
     "main": "index.js",
     "author": "Daniel Corcoran",