feat: automate package publishing using semantic-release

.github/workflows/lint.pr.yml

@@ -6,11 +6,14 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3
+    - name: Checkout repository
+      uses: actions/checkout@v3
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
       with:
         node-version: current
-    - uses: pnpm/action-setup@v2
+    - name: Install pnpm and dependencies
+      uses: pnpm/action-setup@v2
       with:
         version: 7
         run_install: true

.github/workflows/pr-title-linter.yml

@@ -0,0 +1,107 @@
+name: PR Title Checker
+
+on:
+  pull_request:
+    types: ["opened", "edited", "reopened", "synchronize"]
+    branches: 
+      - '*'
+      - '*/*'
+      - '**'    
+      - '!master'
+
+jobs:
+  check:
+    name: Validate PR Title
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: current
+      - name : Get Title of PR
+        uses: actions/github-script@v6
+        id: pr-title
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          result-encoding: json
+          script: |
+            const { data: pr } = await github.rest.issues.get({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo
+            });
+            return pr.title;
+      - name : Test Title of PR
+        uses: actions/github-script@v6
+        id: pr-title-check
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          result-encoding: json
+          script: |
+            const prTitle = ${{steps.pr-title.outputs.result}};
+            const regex = new RegExp('^(chore|docs|feat|fix|perf|refactor|style|test|build|revert)((.+))?:(.+)');
+            return !regex.test(prTitle);
+      - name: Update PR Comment
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          result-encoding: json
+          script: |
+            // Retrieve existing bot comments for the PR
+            const { data: comments } = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+            });
+            const botComment = comments.find(comment => {
+              return comment.user.type === 'Bot' && comment.body.includes('Incorrect Pull Request Title Format')
+            });
+
+            if (${{steps.pr-title-check.outputs.result}}) {
+              const body = `**Incorrect Pull Request Title Format**
+                The title of this pull request does not appear to match the commit message format.
+                \`\`\`
+                Examples from Commitizen
+                \`\`\`
+                ![](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)
+              `;
+
+              // If we have a comment, update it, otherwise create a new one
+              if (botComment) {
+                github.rest.issues.updateComment({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  comment_id: botComment.id,
+                  body
+                });
+              } else {
+                github.rest.issues.createComment({
+                  issue_number: context.issue.number,
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  body
+                });
+              }
+              return;
+            }
+            if (botComment) {
+              github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: botComment.id,
+                body: `:sparkles: **Valid Pull Request Title Format** :sparkles:`,
+              });
+              return;
+            }
+      - name: Check PR Title Status
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          result-encoding: json
+          script: |
+            const hasError = ${{steps.pr-title-check.outputs.result}};
+            if (hasError) {
+              core.setFailed('PR Title Checker job has failed!');
+            }

.github/workflows/release.yml

@@ -0,0 +1,31 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+      - alpha
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: current
+      - name: Install pnpm and dependencies
+        uses: pnpm/action-setup@v2
+        with:
+          version: 7
+          run_install: true
+      - name: Test
+        run: pnpm test
+      - name: Build
+        run: pnpm build
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

.github/workflows/test.js.yml

@@ -6,11 +6,14 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3
+    - name: Checkout repository
+      uses: actions/checkout@v3
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
       with:
         node-version: current
-    - uses: pnpm/action-setup@v2
+    - name: Install pnpm and dependencies
+      uses: pnpm/action-setup@v2
       with:
         version: 7
         run_install: true

.github/workflows/update-alpha.yml

@@ -0,0 +1,20 @@
+name: Update alpha
+on:
+  workflow_run:
+    workflows:
+      - Release
+    branches:
+      - master
+    types: completed
+jobs:
+  rebase:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Rebase alpha to master
+        run: |
+          git fetch --unshallow
+          git checkout alpha
+          git rebase origin/master
+          git push

.releaserc.json

@@ -0,0 +1,21 @@
+{
+  "branches": [{ "name": "master" }, { "name": "alpha", "prerelease": true }],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    [
+      "@semantic-release/npm",
+      {
+        "tarballDir": "release"
+      }
+    ],
+    [
+      "@semantic-release/github",
+      {
+        "assets": "release/*.tgz"
+      }
+    ],
+    "@semantic-release/git"
+  ]
+}

README.md

@@ -34,4 +34,29 @@ Run `node dev.js` or `pnpm dev`
 Usage: node dev.js [-c <string> | --cliClasses=<string>] [--usePixels] [--development] [--externalClasses] [--externalizeClasses] [--usePreflight]
 
 Example: `node dev.js --usePixels --development --cliClasses=m-2`
-! Do not use shortcut when passing negative values, e.g. `node dev.js --cliClasses='-m-2! gap-2'`
+! Do not use shortcut when passing negative values, e.g. `node dev.js --cliClasses='-m-2! gap-2'`
+
+## Contributing
+
+We use [commitizen](https://github.com/commitizen/cz-cli) to ensure coherent commit message structure, used by [semantic release](#releases) to generate change logs and handle versioning.
+
+```
+npm install -g commitizen
+```
+
+When installed, you should be able to type `cz` or `git cz` in your terminal to commit your changes (replacing
+`git commit`).
+
+[![Add and commit with Commitizen](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)
+
+
+## Releases
+
+This project uses [Semantic Release](https://github.com/semantic-release/semantic-release) to automate package
+publishing when making changes to the `master` or `alpha` branch.
+
+It is recommended to branch off the `alpha` branch and follow
+[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) when making changes. When your
+changes are ready for pull request, this should be opened against the `alpha` branch.
+
+Please note that the version published will depend on your commit message structure. Make sure to use commitizen (see [Development section](#Contributing)).

package.json

@@ -1,5 +1,6 @@
 {
   "name": "@warp-ds/uno",
+  "repository": "git@github.com:warp-ds/drive.git",
   "version": "0.0.15",
   "type": "module",
   "exports": {
@@ -17,12 +18,17 @@
     "#preflights": "./src/_preflights/index.js",
     "#postprocess": "./src/postprocessor.js"
   },
+  "files": [
+    "dist",
+    "src",
+    "dev.js"
+  ],
   "scripts": {
+    "commit": "cz",
     "dev": "node dev.js",
     "dev:env": "vite dev-env --config ./vite.config.js",
     "test": "vitest",
     "build": "rollup -c",
-    "version": "pnpm test && pnpm build && pnpm publish",
     "lint": "eslint . --fix",
     "lint:check": "eslint ."
   },
@@ -35,17 +41,29 @@
   },
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^15.0.1",
+    "@semantic-release/changelog": "^6.0.2",
+    "@semantic-release/git": "^10.0.1",
     "@unocss/autocomplete": "^0.50.4",
     "@warp-ds/eslint-config": "^0.0.1",
+    "cz-conventional-changelog": "^3.3.0",
     "drnm": "^0.9.0",
     "eslint": "^8.35.0",
     "rollup": "^3.18.0",
+    "semantic-release": "^20.1.1",
     "unocss": "^0.50.4",
     "uvu": "^0.5.6",
     "vite": "^4.1.4",
     "vitest": "^0.29.2"
   },
   "eslintConfig": {
     "extends": "@warp-ds"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   }
 }