build: add commitizen and semantic-release

BREAKING CHANGE: Automation

Author: codingLogan

.github/workflows/changelogCheck.yml

@@ -0,0 +1,46 @@
+name: Semantic Release
+on:
+  push:
+    branches:
+      - master # or main
+      - lr/workflow-update
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+      
+      - name: Install dependencies
+        run: npm ci
+
+      # consider npm provenance, see https://github.com/semantic-release/semantic-release/blob/master/docs/recipes/ci-configurations/github-actions.md#npm-provenance
+      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+        run: npm audit signatures
+
+      - name: Build
+        run: npm run build
+
+      # Use npx semantic-release to determine the next version
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release --dry-run --no-ci

.github/workflows/npmVersionCheck.yml

@@ -52,18 +52,27 @@ const App = () => {
 
 You need to pass an object containing API endpoint callbacks as the `apiValue` prop of the ApiProvider as described in the [usage](#usage) section for the widget to work. [Here](./docs/APIDOCUMENTATION.md) is a more detailed list of the API endpoint callbacks.
 
-## Developing
+## Development Set Up
 
 1. Clone project
 2. Install `Node(with npm)`. See [package.json](/package.json) for current required versions
 3. Run `npm i`
-4. Make your code changes
+4. Make your code changes - [Follow Conventional Commits](#commit-message-requirements)
 5. Run `npm run build` to build the project
 6. [Link Project](#linking-for-development)
 7. Test your changes
-8. Update change log, translations, and documentation as needed
+8. Update translations and documentation as needed
 9. Open Pull Request
 
+## Commit Message Requirements
+
+_To make commits that trigger a package release, use `npx cz`, it will launch easy to follow commitizen prompts._
+
+A new _MAJOR.MINOR.PATCH_ release will be generated if at least one of the following types are used, see [Conventional Commits Documentation](https://www.conventionalcommits.org/) for more specifics.
+* `fix:` -> PATCH bump
+* `feat:` -> MINOR bump
+* `<any_type>!:` -> MAJOR bump (any type with a ! after it, or a footer of `BREAKING CHANGE:`)
+
 ## Linking for Development
 
 For developing this package locally, we suggest you use npm link to connect your local version of the package to your client app using the package.
@@ -79,6 +88,6 @@ Pull requests are welcome. Please open an issue first to discuss what you would
 
 Make sure to add/update tests, translations, and documentation as appropriate.
 
-## Changelog
+## Release Notes
 
-View our changelog [here](./CHANGELOG.md)
+View our release notes on [npm](https://www.npmjs.com/package/@mxenabled/connect-widget)