Feature/prerelease support

.github/actions/release/action.yml

@@ -0,0 +1,62 @@
+name: release
+description: Base package release action
+inputs:
+  npm_token:
+    description: "Token to authenticate with the npm registry"
+    required: true
+runs:
+  using: composite
+  steps:
+    - name: Setup Node
+      uses: actions/setup-node@v3
+      with:
+        node-version: '16.x'
+        registry-url: 'https://registry.npmjs.org'
+
+    - name: Configure git
+      run: |
+        git config --global user.email "github-actions[bot]@users.noreply.github.com"
+        git config --global user.name "github-actions[bot]"
+      shell: bash
+
+    - run: git fetch --prune --unshallow
+      shell: bash
+
+    - name: Install dependencies
+      run: npm install -g pnpm@8 && pnpm install --production --ignore-scripts
+      shell: bash
+
+    - name: Create .npmrc
+      run: echo "//registry.npmjs.org/:_authToken=${{ inputs.npm_token }}" > .npmrc
+      shell: bash
+
+    - run: echo "git-checks=false" >> .npmrc
+      shell: bash
+
+    - name: Sync submodules
+      run: pnpm sync-submodules
+      shell: bash
+
+    - name: Populate prerequisities
+      run: |
+        echo "{ \"release_tag\": \"$TAG\" }" > cache-control.json
+        cd packages && for p in *; do if [ -d "$p" ]; then cp ../.npmignore ../LICENSE ../cache-control.json $p/; fi; done && cd ..
+        cd plugins && for p in *; do if [ -d "$p" ]; then cp ../.npmignore ../LICENSE ../cache-control.json $p/; fi; done && cd ..
+      shell: bash
+
+    - name: Publish packages on NPM
+      run: |
+        pnpm --filter @sliit-foss/automatic-versioning build && npm i -g ./packages/automatic-versioning
+        pnpm release
+      shell: bash
+
+    - name: Cleanup
+      run: rm -rf cache-control.json && rm -rf p*/**/cache-control.json
+      shell: bash
+
+    - name: Update release info
+      run: |
+        git config pull.ff true
+        git add . && git commit -m "CI: @sliit-foss/automatic-versioning - sync release" || true
+        git pull --rebase && git push origin
+      shell: bash

.github/workflows/prerelease.yml

@@ -0,0 +1,19 @@
+name: CI Prerelease
+on:
+  push:
+    branches:
+      - development
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    env:
+      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+      TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
+      TAG: blizzard
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/release
+        with:
+          npm_token: ${{ secrets.NPM_TOKEN }}

.github/workflows/release.yml

@@ -8,42 +8,12 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
+    env:
+      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+      TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
+      TAG: latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: ./.github/actions/release
         with:
-          node-version: 16
-
-      - name: Configure git
-        run: |
-          git config --global user.email "github-actions[bot]@users.noreply.github.com"
-          git config --global user.name "github-actions[bot]"
-
-      - run: git fetch --prune --unshallow
-
-      - name: Install dependencies
-        run: npm install -g pnpm@8 @sliit-foss/automatic-versioning@latest && pnpm install --production --ignore-scripts
-
-      - name: Create .npmrc
-        run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > .npmrc
-
-      - run: echo "git-checks=false" >> .npmrc
-
-      - name: Fetch submodules
-        run: |
-          git submodule init
-          git submodule update
-
-      - name: Populate prerequisities
-        run: |
-          cd packages && for p in *; do if [ -d "$p" ]; then cp ../.npmignore ../LICENSE $p/; fi; done && cd ..
-          cd plugins && for p in *; do if [ -d "$p" ]; then cp ../.npmignore ../LICENSE $p/; fi; done && cd ..
-
-      - name: Publish package on NPM
-        run: pnpm release
-
-      - name: Update release info
-        run: |
-          git config pull.ff true
-          git add . && git commit -m "CI: @sliit-foss/automatic-versioning - sync release" || true
-          git pull --rebase && git push origin main
+          npm_token: ${{ secrets.NPM_TOKEN }}

.github/workflows/tests.yml

@@ -3,10 +3,14 @@ on:
   pull_request:
     branches:
       - main
+      - development
 
 jobs:
   unit-tests:
     runs-on: ubuntu-latest
+    env:
+      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+      TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3

.gitignore

@@ -46,4 +46,4 @@ p*/**/jest.config.js
 p*/**/LICENSE
 
 p*/**/node_modules/
-p*/**/logs/
+p*/**/logs/.turbo

.npmignore

@@ -5,4 +5,5 @@ coverage/
 node_modules/
 .babelrc
 jest.config.js
+cache-control.json
 .env

package.json

@@ -8,12 +8,13 @@
   ],
   "scripts": {
     "build": "turbo run build",
-    "bump-version": "turbo run bump-version --concurrency=1",
+    "bump-version": "turbo run bump-version",
     "dev": "turbo run dev",
     "lint": "turbo run lint",
     "format": "prettier --write \"**/*.{js,ts,tsx,md}\"",
     "prepare": "husky install",
-    "release": "turbo run release --concurrency=1",
+    "release": "turbo run release",
+    "sync-submodules": "git submodule init && git submodule update",
     "test": "dotenv -- turbo run test"
   },
   "dependencies": {
@@ -24,7 +25,6 @@
     "esbuild": "0.17.5",
     "esbuild-plugin-glob": "2.2.1",
     "jest": "29.4.1",
-    "prettier": "2.8.3",
     "rimraf": "4.1.2",
     "shx": "0.3.4",
     "turbo": "1.7.3"
@@ -36,7 +36,8 @@
     "eslint": "8.33.0",
     "eslint-config-turbo": "0.0.7",
     "husky": "8.0.3",
-    "nodemon": "2.0.21"
+    "nodemon": "2.0.21",
+    "prettier": "2.8.3"
   },
   "engines": {
     "node": ">=14.0.0"

packages/actions-exec-wrapper/package.json

@@ -1,32 +1,32 @@
-{
-  "name": "@sliit-foss/actions-exec-wrapper",
-  "version": "1.1.1",
-  "description": "A wrapper around the @actions/exec module which promisifies the console output of a command",
-  "main": "dist/index.js",
-  "scripts": {
-    "build": "node ../../scripts/esbuild.config.js",
-    "build:watch": "bash ../../scripts/esbuild.watch.sh",
-    "bump-version": "pnpm build && npx automatic-versioning --name=@sliit-foss/actions-exec-wrapper --no-commit --recursive",
-    "lint": "bash ../../scripts/lint.sh",
-    "release": "bash ../../scripts/release.sh",
-    "test": "bash ../../scripts/test/test.sh"
-  },
-  "dependencies": {
-    "@actions/exec": "1.1.1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sliit-foss/npm-catalogue.git"
-  },
-  "keywords": [
-    "@actions/exec",
-    "actions-exec-wrapper",
-    "console-output"
-  ],
-  "author": "SLIIT FOSS",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/sliit-foss/npm-catalogue/issues"
-  },
-  "homepage": "https://github.com/sliit-foss/npm-catalogue/blob/main/packages/actions-exec-wrapper/readme.md"
-}
+{
+  "name": "@sliit-foss/actions-exec-wrapper",
+  "version": "1.1.1",
+  "description": "A wrapper around the @actions/exec module which promisifies the console output of a command",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "node ../../scripts/esbuild.config.js",
+    "build:watch": "bash ../../scripts/esbuild.watch.sh",
+    "bump-version": "bash ../../scripts/bump-version.sh --name=@sliit-foss/actions-exec-wrapper",
+    "lint": "bash ../../scripts/lint.sh",
+    "release": "bash ../../scripts/release.sh",
+    "test": "bash ../../scripts/test/test.sh"
+  },
+  "dependencies": {
+    "@actions/exec": "1.1.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sliit-foss/npm-catalogue.git"
+  },
+  "keywords": [
+    "@actions/exec",
+    "actions-exec-wrapper",
+    "console-output"
+  ],
+  "author": "SLIIT FOSS",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sliit-foss/npm-catalogue/issues"
+  },
+  "homepage": "https://github.com/sliit-foss/npm-catalogue/blob/main/packages/actions-exec-wrapper/readme.md"
+}

packages/automatic-versioning/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@sliit-foss/automatic-versioning",
-  "version": "1.2.1",
+  "version": "1.4.3-blizzard.1",
   "description": "A script which will automatically increment your app package version in accordance with conventional commits",
   "main": "dist/index.js",
   "bin": "dist/index.js",
   "scripts": {
     "build": "node ../../scripts/esbuild.config.js",
     "build:watch": "bash ../../scripts/esbuild.watch.sh",
-    "bump-version": "pnpm build && node dist/index.js --no-commit --recursive",
+    "bump-version": "bash ../../scripts/bump-version.sh",
     "lint": "bash ../../scripts/lint.sh",
     "release": "bash ../../scripts/release.sh",
     "test": "dotenv -- jest --coverage --verbose --runInBand --forceExit"

packages/automatic-versioning/readme.md

@@ -93,34 +93,62 @@ yarn bump-version
     - Fix   - bump patch version
 ```
 
-## Disable version bumping for specific commit<br/><br/>
+## Disable commit <br/>
 
-- Add the following to your commit message: "--no-bump"<br/>
+- By default automatic-versioning will commit the newly incremented version to source control. To disable this behavior, add the following to your script: "--no-commit"<br/>
+
+```bash
+  npx automatic-versioning --name=<package_name> --no-commit
+```
+
+## Disable version bumping for specific commit<br/>
 
 ```bash
   git commit -m "Feat: some feature --no-bump"
 ```
 
-## Disable --no-bump commit message edit <br/><br/>
+## Disable --no-bump commit message edit <br/>
 
 - By default automatic-versioning will edit the commit message in no-bump commits and remove the no-bump part from the commit message. Sometimes such as in the case of monorepos, this can prove to be a problem. To disable this behavior, add the following to your script: "--no-commit-edit"<br/>
 
 ```bash
   npx automatic-versioning --name=<package_name> --no-commit-edit
 ```
 
-## Custom app directory to run incrementing script<br/><br/>
-
-- Add the following option to your bump script: "--rootDir=<custom_dir>"<br/>
+## Custom app directory to run incrementing script<br/>
 
 ```bash
   npx automatic-versioning --name=<package_name> --rootDir=<custom_dir>
 ```
 
-## Recursively search commit history to find version bump trigger<br/><br/>
-
-- Add the following option to your bump script: "--recursive"<br/>
+## Recursively search commit history to find version bump trigger<br/>
 
 ```bash
   npx automatic-versioning --name=<package_name> --recursive
 ```
+
+## Custom prerelease tag<br/>
+
+```bash
+  npx automatic-versioning --name=<package_name> --prerelease-tag=<name>
+```
+
+## Prerelease branch<br/>
+
+- If this option is specified and the current branch matches it, the versioning will be evaluated as follows <br/>
+
+  - Feat! --> Premajor
+  - Feat --> Preminor
+  - Fix --> Prepatch
+
+```bash
+  npx automatic-versioning --name=<package_name> --prerelease-branch=<branch_name>
+```
+
+## Ignore prefixes<br/>
+
+- A list of comma separated prefixes to ignore when evaluating the commit message. By default we stop searching for commits once we come across any prefix considered by commitlint as valid prefixes. You can use this option to ignore a few of them if the need arises<br/>
+
+```bash
+  npx automatic-versioning --name=<package_name> --ignore-prefixes=ci,docs
+```