feat: add semantic-release workflow

Author: zachfedor

.github/workflows/release.yml

@@ -2,61 +2,73 @@ name: Release
 
 on:
   push:
-    tags:
-      - "v*"
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+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 trusted publishing and npm provenance
 
 jobs:
-  release:
+  validate:
+    name: 🔍 Validate
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      id-token: write
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v5
 
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
+      - name: ⎔ Setup node
+        uses: actions/setup-node@v6
         with:
-          node-version: "20"
-          cache: "npm"
-          registry-url: "https://registry.npmjs.org"
+          node-version: lts/*
 
-      - name: Install dependencies
-        run: npm ci
+      - name: 📥 Download deps
+        uses: bahmutov/npm-install@v1
+        with:
+          useLockFile: false # better for libraries
 
-      - name: Validate package
+      - name: 🔍 Validate
         run: npm run validate
 
-      - name: Publish to npm
-        run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-      - name: Generate release notes
-        id: release_notes
-        run: |
-          # Extract version from tag
-          VERSION=${GITHUB_REF#refs/tags/v}
-          echo "version=$VERSION" >> $GITHUB_OUTPUT
-
-          # Generate changelog since last tag
-          PREV_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
-          if [ -n "$PREV_TAG" ]; then
-            echo "## Changes" > release_notes.md
-            git log --pretty=format:"- %s (%h)" $PREV_TAG..HEAD >> release_notes.md
-          else
-            echo "## Initial Release" > release_notes.md
-            echo "First release of @aha-co/config" >> release_notes.md
-          fi
-
-      - name: Create GitHub Release
-        uses: actions/create-release@v1
+  release:
+    name: 🚀 Release
+    needs: [validate]
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v5
+
+      - name: ⎔ Setup node
+        uses: actions/setup-node@v6
+        with:
+          node-version: lts/*
+
+      - name: 📥 Download deps
+        uses: bahmutov/npm-install@v1
+        with:
+          useLockFile: false # better for libraries
+
+      - name: ✍️ Verify signatures
+        run: npm audit signatures
+
+      - name: 🚀 Release
+        uses: cycjimmy/semantic-release-action@v6
+        with: semantic_version: 25
+        branches: |
+            [
+              '+([0-9])?(.{+([0-9]),x}).x',
+              'main',
+              'next',
+              'next-major',
+              {name: 'beta', prerelease: true},
+              {name: 'alpha', prerelease: true}
+            ]
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ steps.release_notes.outputs.version }}
-          body_path: release_notes.md
-          draft: false
-          prerelease: ${{ contains(github.ref, '-') }}
+          NPM_CONFIG_PROVENANCE: true

README.md

@@ -10,7 +10,7 @@
   </a>
 </div>
 
-# @aha-co/config
+# @theahaco/ts-config
 
 Standardized set of configuration files for TypeScript projects so we don't have
 to think about them. Heavily inspired by
@@ -22,7 +22,7 @@ These are a set of defaults and everything can be overridden as needed per
 project.
 
 ```
-npm install @aha-co/config
+npm install @theahaco/ts-config
 ```
 
 ### TypeScript
@@ -32,7 +32,7 @@ Create a `tsconfig.json` file in the project root and
 
 ```json
 {
-	"extends": ["@aha-co/config/typescript"],
+	"extends": ["@theahaco/ts-config/typescript"],
 	"include": ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"],
 	"compilerOptions": {
 		// override here
@@ -43,7 +43,7 @@ Create a `tsconfig.json` file in the project root and
 Create a `reset.d.ts` file:
 
 ```ts
-import "@aha-co/config/reset.d.ts"
+import "@theahaco/ts-config/reset.d.ts"
 ```
 
 #### TS for Libraries
@@ -54,7 +54,7 @@ be consumable in as many setups as possible. You can extend a different config
 instead:
 
 ```json
-  extends: ["@aha-co/config/typescript.lib"],
+  extends: ["@theahaco/ts-config/typescript.lib"],
 ```
 
 ### ESLint
@@ -63,7 +63,7 @@ Create a `eslint.config.js` file in the project root and
 [extend this config file](https://eslint.org/docs/latest/extend/shareable-configs#overriding-settings-from-shareable-configs):
 
 ```js
-import { config } from "@aha-co/config/eslint"
+import { config } from "@theahaco/ts-config/eslint"
 
 /** @type {import("eslint").Linter.Config[]} */
 export default [
@@ -77,7 +77,7 @@ export default [
 Add a line in `package.json` to point to this config file:
 
 ```json
-  "prettier": "@aha-co/config/prettier",
+  "prettier": "@theahaco/ts-config/prettier",
 ```
 
 You can add a `.prettierignore` file to your project root if needed.

index.d.ts

@@ -1,14 +1,14 @@
 /**
- * @aha-co/config main entry point
+ * @theahaco/ts-config main entry point
  *
- * This package provides standardized configurations for Aha JS projects.
- * The main entry point intentionally throws an error as there is no default export.
- * Import specific configurations using the named exports instead:
+ * This package provides standardized configurations for Aha TypeScript and JavaScript
+ * projects. The main entry point intentionally throws an error as there is no default
+ * export. Import specific configurations using the named exports instead:
  *
  * @example
  * ```ts
- * import { config as prettierConfig } from '@aha-co/config/prettier'
- * import { config as eslintConfig } from '@aha-co/config/eslint'
+ * import { config as prettierConfig } from '@theahaco/ts-config/prettier'
+ * import { config as eslintConfig } from '@theahaco/ts-config/eslint'
  * ```
  */