Merge pull request #38 from Mermaid-Chart/PLUG-24-setup-changesets

Setup changesets for automated releases

Author: aloisklink

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
+  "changelog": ["@changesets/changelog-github", { "repo": "Mermaid-Chart/plugins" }],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": ["mermaid-chart-office-addin", "mermaidchart-google"]
+}

.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+permissions:
+  contents: read
+
+jobs:
+  release:
+    if: github.repository == 'Mermaid-Chart/plugins'
+    permissions:
+      contents: write # to create release (changesets/action)
+      id-token: write # Required for npm trusted publishing (OIDC)
+      pull-requests: write # to create pull request (changesets/action)
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: pnpm
+          node-version: "24"
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install Packages
+        run: pnpm install --frozen-lockfile
+
+      - name: Create Release Pull Request or Publish to npm
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          version: pnpm changeset:version
+          publish: pnpm changeset:publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_CONFIG_PROVENANCE: true

README.md

@@ -2,6 +2,19 @@
 
 This repository contains the source code for the Mermaid Chart plugins.
 
+## Releasing
+
+This repo uses [Changesets](https://github.com/changesets/changesets) for versioning and publishing packages to npm.
+
+When you make changes that should be released:
+
+1. Run `pnpm changeset`
+2. Select the affected package(s) and version bump (patch/minor/major)
+3. Add a summary of the change
+4. Commit the changeset file along with your code changes
+
+After your PR is merged to `main`, the release workflow will create a "Version Packages" PR. Merging that PR will publish the updated package(s) to npm.
+
 ## API Documentation
 
 The OpenAPI YAML file is located at [./openapi.yaml](./openapi.yaml).

package.json

@@ -4,14 +4,19 @@
   "private": "true",
   "description": "",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "changeset": "changeset",
+    "changeset:version": "changeset version && pnpm install && git add --all",
+    "changeset:publish": "changeset publish"
   },
   "keywords": [],
   "contributors": [
     "Sidharth Vinod (https://sidharth.dev)"
   ],
   "license": "MIT",
   "devDependencies": {
+    "@changesets/changelog-github": "^0.5.2",
+    "@changesets/cli": "^2.29.8",
     "@cspell/eslint-plugin": "^7.3.2",
     "esbuild": "^0.19.2",
     "eslint": "^8.48.0",

packages/sdk/src/errors.ts

@@ -15,7 +15,7 @@ export class OAuthError extends Error {
  * This corresponds to HTTP 402 status code from the repair API.
  */
 export class AICreditsLimitExceededError extends Error {
-  constructor(message: string = 'AI credits limit exceeded') {
+  constructor(message = 'AI credits limit exceeded') {
     super(message);
     this.name = 'AICreditsLimitExceededError';
   }