feat: Allows publishing on dev branch/distribution channel

.eslintrc.cjs

@@ -16,7 +16,7 @@ module.exports = {
     extraFileExtensions: ['.md', '.css'],
   },
   plugins: ['react', 'react-hooks'],
-  ignorePatterns: ['.eslintrc.js'],
+  ignorePatterns: ['.eslintrc.js', 'commitlint.config.js'],
   rules: {
     semi: 'off',
     '@typescript-eslint/explicit-function-return-type': [

.github/workflows/pr-branch-check-name.yml

@@ -0,0 +1,56 @@
+name: 'Branch Name PR Check'
+on:
+  workflow_call:
+  pull_request:
+    types: [opened, reopened, synchronize, edited]
+jobs:
+  pr-branch-name-check:
+    name: 'Check PR for semantic branch name'
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Set PR branch validity'
+        id: is-semantic
+        if: >
+          startsWith(github.event.pull_request.head.ref, 'feat/') ||
+          startsWith(github.event.pull_request.head.ref, 'ci/') ||
+          startsWith(github.event.pull_request.head.ref, 'fix/') ||
+          startsWith(github.event.pull_request.head.ref, 'docs/') ||
+          startsWith(github.event.pull_request.head.ref, 'test/') ||
+          startsWith(github.event.pull_request.head.ref, 'refactor/') ||
+          startsWith(github.event.pull_request.head.ref, 'style/') ||
+          startsWith(github.event.pull_request.head.ref, 'build/') ||
+          startsWith(github.event.pull_request.head.ref, 'chore/') ||
+          startsWith(github.event.pull_request.head.ref, 'revert/') ||
+          startsWith(github.event.pull_request.head.ref, 'dependabot/') ||
+          startsWith(github.event.pull_request.head.ref, 'dev')
+        run: |
+          OUTPUT=true
+          echo "isSemantic=$OUTPUT" >> $GITHUB_OUTPUT
+      - name: 'echo isSemantic'
+        run: |
+          echo ${{ steps.is-semantic.outputs.isSemantic }}
+      - name: 'Branch name is valid'
+        if: ${{steps.is-semantic.outputs.isSemantic == 'true'}}
+        run: |
+          echo 'Pull request branch name is valid.'
+          echo ${{ steps.is-semantic.outputs.isSemantic }}
+      - name: 'Branch name is invalid'
+        if: ${{ steps.is-semantic.outputs.isSemantic != 'true'}}
+        run: |
+          echo ${{ steps.is-semantic.outputs.isSemantic }}
+          echo 'Pull request branch name is not valid.'
+          echo 'branch name must start with one of:'
+          echo '    feat/,'
+          echo '    ci/,'
+          echo '    fix/,'
+          echo '    docs/,'
+          echo '    test/,'
+          echo '    refactor/,'
+          echo '    style/,'
+          echo '    build/,'
+          echo '    chore/,'
+          echo '    revert/,'
+          echo '    dependabot/,'
+          echo '    dev'
+          exit 1

.github/workflows/reusable-workflows.yml

@@ -4,9 +4,6 @@ on:
   pull_request:
 
 jobs:
-  pr-branch-check-name:
-    name: Check PR for semantic branch name
-    uses: mParticle/mparticle-workflows/.github/workflows/pr-branch-check-name.yml@stable
   pr-title-check:
     name: Check PR for semantic title
     uses: mParticle/mparticle-workflows/.github/workflows/pr-title-check.yml@stable

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "$1"

CHANGELOG.md

@@ -0,0 +1,3 @@
+## [1.9.6-dev.1](https://github.com/mParticle/aquarium/compare/v1.9.5...v1.9.6-dev.1) (2024-03-25)
+
+## [1.8.3-dev.3](https://github.com/mParticle/aquarium/compare/v1.8.3-dev.2...v1.8.3-dev.3) (2024-03-20)

CONTRIBUTING.md

@@ -7,7 +7,7 @@ Thanks for contributing! Please read this document to follow our conventions for
 - Clone the repository and run `npm install`
 - Run `npm start` to start storybook
 
-## Testing in Nancy
+## Testing in Nancy codebase
 
 In order to test your changes, you will need to link the local version of the library. To do this, run the following commands:
 
@@ -17,6 +17,10 @@ In order to test your changes, you will need to link the local version of the li
 - `yarn link @mparticle/aquarium` in the root of Nancy
 - Make sure your _/node_modules/@mparticle/aquarium_ folder contains all of the Aquarium code
 
+## Testing in Indicative codebase
+
+TODO
+
 ## Testing by installing from a branch
 
 Another way to test your changes is by installing the library from a branch. To do this, we need to push the _dist/_ folder to the remote
@@ -26,19 +30,25 @@ and install it directly from there with the following command:
 yarn add https://github.com/mParticle/aquarium#<branch-name>
 ```
 
-## Releasing
+### Release Process
 
 We use semantic-release for releasing new versions of the library.
 
-## Releasing beta versions
+## Releasing development versions
 
-[TODO](https://mparticle-eng.atlassian.net/browse/UNI-264)
+To test development version of the Aquarium we use the `dev` branch on Github and `dev` distribution channel on npm.
+This allows us to install a version of the library by running the following command:
+
+```
+yarn add @mparticle/aquarium@dev
+```
 
 ## Commit conventions and PR titles
 
 - We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to help automating the release process. Both PR titles and commit messages should follow this convention.
 - [This repo is commitizen friendly](https://github.com/commitizen/cz-cli?tab=readme-ov-file#using-the-command-line-tool) so we can use `git cz` to commit changes.
   `npx cz` is also available if you don't have commitizen installed globally.
+- We also have a [commitlint](https://commitlint.js.org/) setup to enforce the commit message format.
 
 The standard format for commit messages is as follows:
 
@@ -72,3 +82,27 @@ In the footer, if there is a breaking change, start your footer with `BREAKING C
   - Also, if you're using VSCode you might want to set prettier as the default formatter and also turn on "Format on Save" option.
 - **ESLint**: Check [Integrations doc page](https://eslint.org/docs/latest/use/integrations)
 - **Stylelint**: Check [Editor integrations doc page](https://stylelint.io/awesome-stylelint/#editor-integrations)
+
+## Contributing with the release process
+
+To make changes to the release process, you can use the `--dry-run` from semantic-release flag to test the release
+process without actually publishing a new version.
+
+You will need two environment variables to run the release process locally:
+
+- NPM_TOKEN: You can create a personal npm account and use a personal token.
+  Since we are using `--dry-run` it won't try to publish anything so having a valid read-only npm token works.
+
+- GITHUB_TOKEN: Create a [github personal access token (classic)](https://github.com/settings/tokens)
+  and give it access to the mParticle organization via "Configure SSO" button.
+
+After settings both variables locally, run the following locally:
+
+```
+npx semantic-release --dry-run
+```
+
+## Additional readings:
+
+- [Semantic Release Workflow Configuration](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/workflow-configuration.md#workflow-configuration)
+- [Understanding npm distribution channels](https://docs.npmjs.com/cli/v8/commands/npm-dist-tag#purpose)

commitlint.config.js

@@ -0,0 +1,3 @@
+export default {
+  extends: ['@commitlint/config-conventional'],
+}