Merge pull request #18 from dkmaker/feat/release-please-workflow

feat: migrate to Release Please for controlled releases

Author: dkmaker

.github/conventional-changelog.config.cjs

@@ -0,0 +1,45 @@
+version: 2
+updates:
+  # npm dependencies
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: "chore(deps)"
+    labels:
+      - "dependencies"
+    groups:
+      # Group minor and patch updates together
+      production-dependencies:
+        patterns:
+          - "*"
+        exclude-patterns:
+          - "@types/*"
+          - "typescript"
+          - "@commitlint/*"
+        update-types:
+          - "minor"
+          - "patch"
+      dev-dependencies:
+        patterns:
+          - "@types/*"
+          - "typescript"
+          - "@commitlint/*"
+        update-types:
+          - "minor"
+          - "patch"
+
+  # GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    commit-message:
+      prefix: "chore(deps)"
+    labels:
+      - "dependencies"
+      - "github-actions"

.github/conventional-changelog.config.js

@@ -0,0 +1,30 @@
+name: Publish to NPM
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish to NPM with Provenance
+        run: npm publish --provenance --access public

.github/dependabot.yml

@@ -1,8 +1,5 @@
 name: PR Review with Progress Tracking
 
-# This example demonstrates how to use the track_progress feature to get
-# visual progress tracking for PR reviews, similar to v0.x agent mode.
-
 on:
   pull_request:
     types: [opened, synchronize, ready_for_review, reopened]
@@ -18,57 +15,91 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v5
         with:
-          fetch-depth: 1
+          fetch-depth: 0
 
       - name: PR Review with Progress Tracking
         uses: anthropics/claude-code-action@v1
         with:
           anthropic_api_key: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
 
-          # Enable progress tracking
           track_progress: true
 
-          # Your custom review instructions
           prompt: |
             REPO: ${{ github.repository }}
             PR NUMBER: ${{ github.event.pull_request.number }}
 
             Perform a comprehensive code review with the following focus areas:
 
-            1. **Code Quality**
-               - Clean code principles and best practices
-               - Proper error handling and edge cases
-               - Code readability and maintainability
+            ## 1. Release Workflow Compliance (CRITICAL)
 
-            2. **Security**
-               - Check for potential security vulnerabilities
-               - Validate input sanitization
-               - Review authentication/authorization logic
+            This project uses Release Please with Conventional Commits. Check:
 
-            3. **Performance**
-               - Identify potential performance bottlenecks
-               - Review database queries for efficiency
-               - Check for memory leaks or resource issues
+            **Commit Message Format:**
+            - All commits MUST follow conventional commit format: `type(scope): description`
+            - Valid types: `feat`, `fix`, `perf`, `refactor`, `docs`, `test`, `ci`, `build`, `chore`, `style`
+            - Type must be lowercase
+            - Description must be lowercase and not end with a period
+            - Breaking changes must include `BREAKING CHANGE:` in the commit footer
 
-            4. **Testing**
-               - Verify adequate test coverage
-               - Review test quality and edge cases
-               - Check for missing test scenarios
+            **Version Bump Rules (explain to contributor):**
+            - `feat:` → Minor version bump (0.4.0 → 0.5.0)
+            - `fix:`, `perf:`, `refactor:` → Patch version bump (0.4.0 → 0.4.1)
+            - `docs:`, `test:`, `ci:`, `build:`, `chore:`, `style:` → No version bump
+            - `BREAKING CHANGE:` footer → Major version bump
 
-            5. **Documentation**
-               - Ensure code is properly documented
-               - Verify README updates for new features
-               - Check API documentation accuracy
+            **If commits don't follow the format:**
+            - List each non-compliant commit
+            - Show the correct format it should use
+            - Suggest squashing/rewording before merge
 
-            Provide detailed feedback using inline comments for specific issues.
-            Use top-level comments for general observations or praise.
+            Run this command to check commits:
+            ```
+            git log --oneline origin/main..HEAD
+            ```
 
-          # Tools for comprehensive PR review
-          claude_args: |
-            --allowedTools "mcp__github_inline_comment__create_inline_comment,Bash(gh pr comment:*),Bash(gh pr diff:*),Bash(gh pr view:*)"
+            ## 2. Code Quality
+            - Clean code principles and best practices
+            - Proper error handling and edge cases
+            - Code readability and maintainability
+
+            ## 3. Security
+            - Check for potential security vulnerabilities
+            - Validate input sanitization
+            - Review authentication/authorization logic
+            - Check for secrets or credentials in code
+
+            ## 4. Performance
+            - Identify potential performance bottlenecks
+            - Check for memory leaks or resource issues
+
+            ## 5. Testing
+            - Verify adequate test coverage for new features
+            - Review test quality and edge cases
+
+            ## 6. Documentation
+            - New features should update README.md if user-facing
+            - Breaking changes should be clearly documented
+
+            ## Review Output Format
 
-# When track_progress is enabled:
-# - Creates a tracking comment with progress checkboxes
-# - Includes all PR context (comments, attachments, images)
-# - Updates progress as the review proceeds
-# - Marks as completed when done
+            Start your review with a **Release Compliance Summary**:
+
+            ```
+            ## Release Compliance Check
+
+            | Commit | Format | Type | Valid |
+            |--------|--------|------|-------|
+            | abc123 | feat: add feature | feat | ✅ |
+            | def456 | Update readme | INVALID | ❌ |
+
+            **Action Required:** [Yes/No]
+            ```
+
+            If any commits are invalid, provide clear instructions on how to fix them
+            (e.g., interactive rebase commands).
+
+            Then proceed with the rest of the code review using inline comments
+            for specific issues and top-level comments for general observations.
+
+          claude_args: |
+            --allowedTools "mcp__github_inline_comment__create_inline_comment,Bash(gh pr comment:*),Bash(gh pr diff:*),Bash(gh pr view:*),Bash(git log:*),Bash(git show:*)"

.github/workflows/npm-publish.yml

@@ -15,5 +15,5 @@ jobs:
       - name: Refresh badges
         uses: b3b00/refreshBadgesAction@v1.0.7
         with:
-          repository: 'zenturacp/mcp-rest-api'
+          repository: 'dkmaker/mcp-rest-api'
           branch: 'main'

.github/workflows/pr-review-comprehensive.yml

@@ -0,0 +1,20 @@
+name: Release Please
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json

.github/workflows/publish.yml

@@ -0,0 +1,3 @@
+{
+  ".": "0.4.0"
+}

.github/workflows/refresh-badges.yml

@@ -1,27 +1,24 @@
-## [0.4.0](https://github.com/dkmaker/mcp-rest-api/compare/v0.3.0...v0.4.0) (2025-01-08)
+# Changelog
 
+## [0.4.0](https://github.com/dkmaker/mcp-rest-api/compare/v0.3.0...v0.4.0) (2025-01-08)
 
 ### Features
 
 * add custom header support ([9a48e0d](https://github.com/dkmaker/mcp-rest-api/commit/9a48e0d794a743f7a62c7cb73d6f5b1be9e44107))
 
 ## [0.3.0](https://github.com/dkmaker/mcp-rest-api/compare/v0.2.0...v0.3.0) (2024-12-28)
 
-
 ### Features
 
 * add config documentation and improve URL resolution examples ([8c6100f](https://github.com/dkmaker/mcp-rest-api/commit/8c6100f47777605a0571edbd161ffd20fc48b640))
 * add MCP resources for documentation ([a20cf35](https://github.com/dkmaker/mcp-rest-api/commit/a20cf352e9731841a8d7e833007a96bdd1a0c390))
 
-
 ### Bug Fixes
 
 * correct response truncation to return first N bytes ([ce34649](https://github.com/dkmaker/mcp-rest-api/commit/ce34649c4d8e6bc6d740e8f3fbc6e3df517e0eec))
 
 ## [0.2.0](https://github.com/dkmaker/mcp-rest-api/compare/0fdbe844dd4ce8b79f38a33df323a29e28253724...v0.2.0) (2024-12-21)
 
-
 ### Features
 
 * **ssl:** add SSL verification control with secure defaults ([0fdbe84](https://github.com/dkmaker/mcp-rest-api/commit/0fdbe844dd4ce8b79f38a33df323a29e28253724))
-