Merge pull request #3 from MostafaRastegar/develop

docs(README): update installation guide

Author: MostafaRastegar

.github/workflows/release.yml

@@ -5,38 +5,73 @@ on:
     branches:
       - main
       - next
+  push:
+    branches:
+      - main
+      - next
 
 permissions:
   contents: write
   issues: write
   pull-requests: write
+  packages: write
 
 jobs:
   release:
     runs-on: ubuntu-latest
-    # Only run if PR was merged (not just closed)
-    if: github.event.pull_request.merged == true
+    if: |
+      (github.event_name == 'pull_request' && github.event.pull_request.merged == true) ||
+      (github.event_name == 'push')
+    
     steps:
-      - uses: actions/checkout@v4
+      - name: 🔍 Debug Info
+        run: |
+          echo "Event: ${{ github.event_name }}"
+          echo "Ref: ${{ github.ref }}"
+          echo "Branch: ${{ github.ref_name }}"
+          echo "Merged: ${{ github.event.pull_request.merged }}"
+
+      - name: 📥 Checkout
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0  # Required for semantic-release
-          ref: ${{ github.event.pull_request.base.ref }}  # Checkout the target branch
+          token: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: actions/setup-node@v4
+      - name: 📦 Setup Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: "22.x"
           cache: 'npm'
+          registry-url: 'https://registry.npmjs.org'
 
-      - run: npm ci
-      - run: npm run build
-      - run: npm audit signatures
+      - name: 📋 Install dependencies
+        run: npm ci
+
+      - name: 🏗️ Build
+        run: npm run build
+        
+      - name: 🔐 Audit
+        run: npm audit signatures
 
-      # Optional: Run tests before release
-      - name: Run tests
+      - name: 🧪 Run tests
         run: npm run test:ci
 
-      - name: Release
+      - name: 🔍 Debug semantic-release (dry-run)
+        run: npx semantic-release --dry-run
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npx semantic-release
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        
+      - name: 🚀 Release
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: 📊 Release Status
+        if: always()
+        run: |
+          echo "✅ Release workflow completed"
+          echo "Check the logs above for any issues"

release.config.cjs

@@ -1,52 +1,94 @@
 // release.config.cjs
 module.exports = {
   branches: ["main", { name: "next", prerelease: true }],
+
+  // Debug mode
+  debug: process.env.CI ? false : true,
+
   plugins: [
     // 1. Analyze commits to determine release type
-    "@semantic-release/commit-analyzer",
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        preset: "angular",
+        releaseRules: [
+          // Documentation changes
+          { type: "docs", release: "patch" },
+          { type: "doc", release: "patch" },
 
-    // 2. Generate release notes from commits
-    "@semantic-release/release-notes-generator",
+          // Code improvements
+          { type: "refactor", release: "patch" },
+          { type: "perf", release: "patch" },
 
-    // 3. Update CHANGELOG.md file
-    "@semantic-release/changelog",
+          // Features and fixes (default behavior)
+          { type: "feat", release: "minor" },
+          { type: "fix", release: "patch" },
 
-    // 4. Update package.json version and publish to NPM
-    "@semantic-release/npm",
+          // Breaking changes
+          { breaking: true, release: "major" },
 
-    // 5. Create Git tag and GitHub release with notes
-    "@semantic-release/github",
+          // No release for these
+          { type: "style", release: false },
+          { type: "chore", release: false },
+          { type: "test", release: false },
+          { type: "ci", release: false },
+          { type: "build", release: false },
+        ],
+        parserOpts: {
+          noteKeywords: ["BREAKING CHANGE", "BREAKING CHANGES"],
+        },
+      },
+    ],
 
-    // 6. Commit updated files (package.json, CHANGELOG.md)
+    // 2. Generate release notes
+    [
+      "@semantic-release/release-notes-generator",
+      {
+        preset: "angular",
+        writerOpts: {
+          commitsSort: ["subject", "scope"],
+        },
+      },
+    ],
+
+    // 3. Update CHANGELOG.md
+    [
+      "@semantic-release/changelog",
+      {
+        changelogFile: "CHANGELOG.md",
+      },
+    ],
+
+    // 4. Update package.json and publish to NPM
+    [
+      "@semantic-release/npm",
+      {
+        npmPublish: true,
+        tarballDir: "dist",
+      },
+    ],
+
+    // 5. Create GitHub release
+    [
+      "@semantic-release/github",
+      {
+        assets: [
+          {
+            path: "dist/*.tgz",
+            label: "Package tarball",
+          },
+        ],
+      },
+    ],
+
+    // 6. Commit updated files (must be last)
     [
       "@semantic-release/git",
       {
-        assets: ["CHANGELOG.md", "package.json"],
+        assets: ["CHANGELOG.md", "package.json", "package-lock.json"],
         message:
           "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}",
       },
     ],
   ],
-
-  // Commit message rules (conventional commits)
-  preset: "angular",
-
-  // Custom release rules
-  releaseRules: [
-    { type: "docs", scope: "README", release: "patch" },
-    { type: "refactor", release: "patch" },
-    { type: "perf", release: "patch" },
-    { type: "style", release: false },
-    { type: "chore", release: false },
-    { type: "test", release: false },
-    { type: "ci", release: false },
-  ],
-
-  // Configure release notes generation
-  generateNotes: {
-    preset: "angular",
-    writerOpts: {
-      commitsSort: ["subject", "scope"],
-    },
-  },
 };