CHORE: Add CI for making sure PRs don't break things

.changeset/fifty-squids-wear.md

@@ -0,0 +1,5 @@
+---
+"task-master-ai": patch
+---
+
+Add CI for testing

.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - next
+  pull_request:
+    branches:
+      - main
+      - next
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "npm"
+
+      - name: Cache node_modules
+        uses: actions/cache@v4
+        with:
+          path: |
+            node_modules
+            */*/node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Install Dependencies
+        run: npm ci
+        timeout-minutes: 2
+
+      - name: Run Tests
+        run: |
+          npm run test:coverage -- --coverageThreshold '{"global":{"branches":0,"functions":0,"lines":0,"statements":0}}' --detectOpenHandles --forceExit
+        env:
+          NODE_ENV: test
+          CI: true
+          FORCE_COLOR: 1
+        timeout-minutes: 15
+
+      - name: Upload Test Results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results-node
+          path: |
+            test-results
+            coverage
+            junit.xml
+          retention-days: 30

.github/workflows/release.yml

@@ -14,9 +14,21 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 20
+          cache: "npm"
+
+      - name: Cache node_modules
+        uses: actions/cache@v4
+        with:
+          path: |
+            node_modules
+            */*/node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
+        timeout-minutes: 2
 
       - name: Create Release Pull Request or Publish to npm
         uses: changesets/action@v1

README.md

@@ -1,5 +1,9 @@
 # Task Master
 
+[![CI](https://github.com/eyaltoledano/claude-task-master/actions/workflows/ci.yml/badge.svg)](https://github.com/eyaltoledano/claude-task-master/actions/workflows/ci.yml)
+[![License: MIT with Commons Clause](https://img.shields.io/badge/license-MIT%20with%20Commons%20Clause-blue.svg)](LICENSE)
+[![npm version](https://badge.fury.io/js/task-master-ai.svg)](https://badge.fury.io/js/task-master-ai)
+
 ### by [@eyaltoledano](https://x.com/eyaltoledano)
 
 A task management system for AI-driven development with Claude, designed to work seamlessly with Cursor AI.

tasks/task_040.txt

@@ -0,0 +1,102 @@
+# Task ID: 40
+# Title: Implement Project Funding Documentation and Support Infrastructure
+# Status: in-progress
+# Dependencies: None
+# Priority: medium
+# Description: Create FUNDING.yml for GitHub Sponsors integration that outlines all financial support options for the Task Master project.
+# Details:
+This task involves creating a FUNDING.yml file to enable and manage funding options for the Task Master project:
+
+**FUNDING.yml file**:
+   - Create a .github/FUNDING.yml file following GitHub's specifications
+   - Include configuration for multiple funding platforms:
+     - GitHub Sponsors (primary if available)
+     - Open Collective
+     - Patreon
+     - Ko-fi
+     - Liberapay
+     - Custom funding URLs (project website donation page)
+   - Research and reference successful implementation patterns from Vue.js, React, and TypeScript projects
+   - Ensure the FUNDING.yml contains sufficient information to guide users on how to support the project
+   - Include comments within the YAML file to provide context for each funding option
+
+The implementation should maintain consistent branding and messaging with the rest of the Task Master project. Research at least 5 successful open source projects to identify best practices in funding configuration.
+
+# Test Strategy:
+Testing should verify the technical implementation of the FUNDING.yml file:
+
+1. **FUNDING.yml validation**:
+   - Verify the file is correctly placed in the .github directory
+   - Validate YAML syntax using a linter
+   - Test that GitHub correctly displays funding options on the repository page
+   - Verify all links to external funding platforms are functional
+
+2. **User experience testing**:
+   - Test the complete funding workflow from a potential supporter's perspective
+   - Verify the process is intuitive and barriers to contribution are minimized
+   - Check that the Sponsor button appears correctly on GitHub
+   - Ensure all funding platform links resolve to the correct destinations
+   - Gather feedback from 2-3 potential users on clarity and ease of use
+
+# Subtasks:
+## 1. Research and Create FUNDING.yml File [done]
+### Dependencies: None
+### Description: Research successful funding configurations and create the .github/FUNDING.yml file for GitHub Sponsors integration and other funding platforms.
+### Details:
+Implementation steps:
+1. Create the .github directory at the project root if it doesn't exist
+2. Research funding configurations from 5 successful open source projects (Vue.js, React, TypeScript, etc.)
+3. Document the patterns and approaches used in these projects
+4. Create the FUNDING.yml file with the following platforms:
+   - GitHub Sponsors (primary)
+   - Open Collective
+   - Patreon
+   - Ko-fi
+   - Liberapay
+   - Custom donation URL for the project website
+5. Validate the YAML syntax using a linter
+6. Test the file by pushing to a test branch and verifying the Sponsor button appears correctly on GitHub
+
+Testing approach:
+- Validate YAML syntax using yamllint or similar tool
+- Test on GitHub by checking if the Sponsor button appears in the repository
+- Verify each funding link resolves to the correct destination
+
+## 4. Add Documentation Comments to FUNDING.yml [pending]
+### Dependencies: 40.1
+### Description: Add comprehensive comments within the FUNDING.yml file to provide context and guidance for each funding option.
+### Details:
+Implementation steps:
+1. Add a header comment explaining the purpose of the file
+2. For each funding platform entry, add comments that explain:
+   - What the platform is
+   - How funds are processed on this platform
+   - Any specific benefits of using this platform
+   - Brief instructions for potential sponsors
+3. Include a comment about how sponsors will be acknowledged
+4. Add information about fund allocation (maintenance, new features, infrastructure)
+5. Ensure comments follow YAML comment syntax and don't break the file structure
+
+Testing approach:
+- Validate that the YAML file still passes linting with comments added
+- Verify the file still functions correctly on GitHub
+- Have at least one team member review the comments for clarity and completeness
+
+## 5. Integrate Funding Information in Project README [pending]
+### Dependencies: 40.1, 40.4
+### Description: Add a section to the project README that highlights the funding options and directs users to the Sponsor button.
+### Details:
+Implementation steps:
+1. Create a 'Support the Project' or 'Sponsorship' section in the README.md
+2. Explain briefly why financial support matters for the project
+3. Direct users to the GitHub Sponsor button
+4. Mention the alternative funding platforms available
+5. Include a brief note on how funds will be used
+6. Add any relevant funding badges (e.g., Open Collective, GitHub Sponsors)
+
+Testing approach:
+- Review the README section for clarity and conciseness
+- Verify all links work correctly
+- Ensure the section is appropriately visible but doesn't overshadow project information
+- Check that badges render correctly
+

tasks/task_041.txt

@@ -0,0 +1,89 @@
+# Task ID: 41
+# Title: Implement GitHub Actions CI Workflow for Task Master
+# Status: pending
+# Dependencies: None
+# Priority: high
+# Description: Create a streamlined CI workflow file (ci.yml) that efficiently tests the Task Master codebase using GitHub Actions.
+# Details:
+Create a GitHub Actions workflow file at `.github/workflows/ci.yml` with the following specifications:
+
+1. Configure the workflow to trigger on:
+   - Push events to any branch
+   - Pull request events targeting any branch
+
+2. Core workflow configuration:
+   - Use Ubuntu latest as the primary testing environment
+   - Use Node.js 20.x (LTS) for consistency with the project
+   - Focus on single environment for speed and simplicity
+
+3. Configure workflow steps to:
+   - Checkout the repository using actions/checkout@v4
+   - Set up Node.js using actions/setup-node@v4 with npm caching
+   - Install dependencies with 'npm ci'
+   - Run tests with 'npm run test:coverage'
+
+4. Implement efficient caching:
+   - Cache node_modules using actions/cache@v4
+   - Use package-lock.json hash for cache key
+   - Implement proper cache restoration keys
+
+5. Ensure proper timeouts:
+   - 2 minutes for dependency installation
+   - Appropriate timeout for test execution
+
+6. Artifact handling:
+   - Upload test results and coverage reports
+   - Use consistent naming for artifacts
+   - Retain artifacts for 30 days
+
+# Test Strategy:
+To verify correct implementation of the GitHub Actions CI workflow:
+
+1. Manual verification:
+   - Check that the file is correctly placed at `.github/workflows/ci.yml`
+   - Verify the YAML syntax is valid
+   - Confirm all required configurations are present
+
+2. Functional testing:
+   - Push a commit to verify the workflow triggers
+   - Create a PR to verify the workflow runs on pull requests
+   - Verify test coverage reports are generated and uploaded
+   - Confirm caching is working effectively
+
+3. Performance testing:
+   - Verify cache hits reduce installation time
+   - Confirm workflow completes within expected timeframe
+   - Check artifact upload and download speeds
+
+# Subtasks:
+## 1. Create Basic GitHub Actions Workflow [pending]
+### Dependencies: None
+### Description: Set up the foundational GitHub Actions workflow file with proper triggers and Node.js setup
+### Details:
+1. Create `.github/workflows/ci.yml`
+2. Configure workflow name and triggers
+3. Set up Ubuntu runner and Node.js 20.x
+4. Implement checkout and Node.js setup actions
+5. Configure npm caching
+6. Test basic workflow functionality
+
+## 2. Implement Test and Coverage Steps [pending]
+### Dependencies: 41.1
+### Description: Add test execution and coverage reporting to the workflow
+### Details:
+1. Add dependency installation with proper timeout
+2. Configure test execution with coverage
+3. Set up test results and coverage artifacts
+4. Verify artifact upload functionality
+5. Test the complete workflow
+
+## 3. Optimize Workflow Performance [pending]
+### Dependencies: 41.1, 41.2
+### Description: Implement caching and performance optimizations
+### Details:
+1. Set up node_modules caching
+2. Configure cache key strategy
+3. Implement proper timeout values
+4. Test caching effectiveness
+5. Document performance improvements
+