Adding publish

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ on:
       - main
 
 env:
-  NODE_VERSION: 20
+  NODE_VERSION: 22
 
 jobs:
   build:
@@ -27,7 +27,7 @@ jobs:
       # Install dependencies
       - uses: pnpm/action-setup@v4
         with:
-          version: 9.15.1
+          version: 10.6.3
           run_install: false
       - name: Install dependencies
         run: pnpm i
@@ -48,3 +48,9 @@ jobs:
           application_uid: zephyr-cloud-docs.zephyr-documentation.zephyrcloudio # Required
       - name: Zephyr deploy summary
         run: echo "Deployed to ${{ steps.zephyr.outputs.version_url }}"
+
+      # Publish the release
+      - name: Publishing Release
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+        run: pnpm run create-release

.github/workflows/on_merge.yml

@@ -5,7 +5,7 @@ on:
     types: [closed]
 
 env:
-  NODE_VERSION: 20
+  NODE_VERSION: 22
 
 jobs:
   run-on-merge:
@@ -24,7 +24,7 @@ jobs:
       # Install dependencies
       - uses: pnpm/action-setup@v4
         with:
-          version: 9.15.1
+          version: 10.6.3
           run_install: false
       - name: Install dependencies
         run: pnpm i

README.md

@@ -14,5 +14,27 @@ pnpm install
 pnpm build
 ```
 
+## Commit guidelines
+
+We follow conventional commits [guidelines](https://www.conventionalcommits.org/en/v1.0.0/).
+
+Default message structure is as follows:
+```markdown
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Additional format description:
+```markdown
+1) fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
+2) feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
+3) BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
+4) types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
+5) footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.
+```
+
 ## Contributors
 ![Alt](https://repobeats.axiom.co/api/embed/fd0de09aa25d444bf55d21d43902d7c71f4e69d2.svg "Repobeats analytics image")

nx.json

@@ -1,22 +1,44 @@
 {
   "$schema": "./node_modules/nx/schemas/nx-schema.json",
+  "defaultProject": "zephyr-documentation",
   "targetDefaults": {
-    "dev": {
-      "outputs": ["{projectRoot}/dist"],
-      "cache": true
-    },
     "build": {
-      "outputs": ["{projectRoot}/build"],
-      "cache": true
-    },
-    "lint": {
-      "cache": true
-    },
-    "lint:fix": {
-      "cache": true
+      "outputs": ["{projectRoot}/doc_build"]
     }
   },
   "defaultBase": "main",
   "nxCloudAccessToken": "Nzk0Y2MxMzYtY2I5Yy00NDkwLWE3MGEtMmYwZmQ4OGIxMWUyfHJlYWQtd3JpdGU=",
-  "useLegacyCache": true
+  "release": {
+    "version": {
+      "conventionalCommits": true
+    },
+    "projects": ["*"],
+    "changelog": {
+      "workspaceChangelog": {
+        "createRelease": "github",
+        "file": false,
+        "renderOptions": {
+          "authors": true,
+          "commitReferences": true,
+          "versionTitleDate": true
+        }
+      }
+    }
+  },
+  "plugins": [
+    {
+      "plugin": "@nx/js/typescript",
+      "options": {
+        "typecheck": {
+          "targetName": "typecheck"
+        },
+        "build": {
+          "targetName": "build",
+          "configName": "tsconfig.lib.json",
+          "buildDepsName": "build-deps",
+          "watchDepsName": "watch-deps"
+        }
+      }
+    }
+  ]
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "zephyr-cloud-docs",
-  "version": "0.0.1",
+  "version": "0.0.9",
   "private": true,
   "repository": {
     "type": "git",
@@ -10,6 +10,7 @@
     "build": "rspress build",
     "build:ci": "node scripts/build-ci.js",
     "dev": "rspress dev --port 3030",
+    "create-release": "nx release --skip-publish",
     "lint": "biome check",
     "lint:fix": "biome check --fix",
     "prepare": "husky",
@@ -43,17 +44,21 @@
     "rspress-plugin-google-analytics": "^0.3.0",
     "tailwind-merge": "^2.6.0",
     "tailwindcss-animate": "^1.0.7",
-    "zephyr-rspack-plugin": "^0.0.34",
+    "zephyr-rspack-plugin": "^0.0.36",
     "zod": "^3.24.2"
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
+    "@nx/js": "20.6.0",
+    "@swc-node/register": "~1.9.1",
+    "@swc/core": "~1.5.7",
+    "@swc/helpers": "~0.5.11",
     "@tailwindcss/typography": "^0.5.16",
     "@types/node": "^22.13.4",
     "@types/react": "^18.3.18",
     "autoprefixer": "^10.4.20",
     "globals": "^15.15.0",
-    "nx": "20.4.4",
+    "nx": "20.6.0",
     "postcss": "^8.5.2",
     "postcss-loader": "^8.1.1",
     "tailwindcss": "^3.4.17",
@@ -65,6 +70,10 @@
   "pnpm": {
     "patchedDependencies": {
       "[email protected]": "patches/[email protected]"
-    }
+    },
+    "onlyBuiltDependencies": [
+      "@swc/core",
+      "nx"
+    ]
   }
 }