fix: craft config and docs (#19)

* fix: updates in config and docs

* fix: renamed the file

Author: MathurAditya724

.craft.yml

@@ -1,5 +1,11 @@
 minVersion: "2.21.2"
 changelog:
   policy: auto
+artifactProvider:
+  name: github
+  config:
+    artifacts:
+      Build & Test:
+        - action-package
 targets:
   - name: github

.github/workflows/main.yml .github/workflows/build.yml.github/workflows/main.yml renamed to .github/workflows/build.yml

@@ -1,3 +1,5 @@
+name: Build & Test
+
 on:
   pull_request:
     branches:
@@ -11,8 +13,8 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       contents: read
-      pull-requests: write  # Required for posting/updating PR comments
-      statuses: write  # Required for reporting commit statuses
+      pull-requests: write # Required for posting/updating PR comments
+      statuses: write # Required for reporting commit statuses
 
     steps:
       - name: Checkout
@@ -22,13 +24,13 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20
-    
+
       - name: Install pnpm
         run: npm install -g pnpm
-    
+
       - name: Install dependencies
         run: pnpm install
-      
+
       - name: Build Action
         run: pnpm run build
 
@@ -43,4 +45,12 @@ jobs:
           post-pr-comment: true
           target-patch: 80
           threshold-project: 1
-          fail-on-error: true
+          fail-on-error: true
+
+      - run: npm pack
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: action-package
+          path: "*.tgz"

README.md

@@ -48,7 +48,7 @@ jobs:
 | Input | Description | Required | Default |
 |-------|-------------|----------|---------|
 | `token` | GitHub token for API access and artifacts | **Yes** | — |
-| `base-branch` | Base branch to compare results against | No | `main` |
+| `base-branch` | Base branch to compare results against | No | Auto-detected |
 | `enable-tests` | Enable test results reporting | No | `true` |
 | `enable-coverage` | Enable coverage reporting | No | `true` |
 | `post-pr-comment` | Post results as a PR comment | No | `false` |
@@ -87,7 +87,7 @@ When thresholds are not configured, status checks report coverage metrics withou
 | Input | Description | Required | Default |
 |-------|-------------|----------|---------|
 | `flags` | Comma-separated flags to tag coverage (e.g., `unittests,frontend`) | No | — |
-| `name` | Custom name for this coverage upload | No | — |
+| `name` | Custom name for this coverage upload. Also used to differentiate artifacts in matrix builds | No | — |
 
 ### Test Results
 
@@ -240,6 +240,35 @@ When thresholds are not configured, status checks report coverage metrics withou
     name: backend-coverage
 ```
 
+### Matrix Builds
+
+When running coverage in a matrix strategy (e.g., multiple Python versions), use the `name` input to give each matrix entry a unique artifact name and avoid upload conflicts:
+
+```yaml
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run tests
+        run: pytest --cov=src --cov-report=xml
+
+      - name: Codecov Action
+        uses: getsentry/codecov-action@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: coverage.xml
+          name: py${{ matrix.python-version }}
+```
+
 ### Coverage Thresholds with Status Checks
 
 Use built-in threshold enforcement with GitHub status checks:
@@ -278,15 +307,18 @@ Multiple coverage files are parsed and aggregated:
 ### 3. Artifact Storage
 
 Results are stored as GitHub Artifacts:
-- `coverage-results-{branch}` — Aggregated coverage data
-- `test-results-{branch}` — Aggregated test results
+- `codecov-coverage-results-{branch}[-{name}][-{flags}]` — Aggregated coverage data
+- `codecov-test-results-{branch}` — Aggregated test results
+
+When using the `name` input, it is appended to the artifact name to avoid conflicts in matrix builds.
 
 ### 4. Base Branch Comparison
 
 On PRs or feature branches:
-1. Downloads latest results from base branch
-2. Compares current vs baseline
-3. Calculates deltas
+1. Auto-detects the repository's default branch (or uses the explicit `base-branch` input)
+2. Downloads latest results from base branch
+3. Compares current vs baseline
+4. Calculates deltas
 
 ### 5. Reporting
 
@@ -469,6 +501,8 @@ permissions:
   statuses: write       # Create commit status checks
 ```
 
+> **Note**: On pull requests from forks, `GITHUB_TOKEN` has restricted permissions regardless of the workflow's `permissions` block. PR comments and commit status checks will be skipped gracefully with a warning in this case. Coverage results and Job Summary are still generated.
+
 ## Migration from Codecov
 
 If you're migrating from the official Codecov action:

action.yml

@@ -1,5 +1,8 @@
 name: Codecov Action
 description: Test results and coverage reporting for GitHub Actions with multi-format support
+branding:
+  icon: activity
+  color: red
 
 inputs:
   # Authentication
@@ -14,34 +17,34 @@ inputs:
   directory:
     description: Folder to search for coverage files. Defaults to current working directory
     required: false
-    default: '.'
+    default: "."
   exclude:
     description: Comma-separated list of folders/patterns to exclude from search
     required: false
 
   # Format handling
   coverage-format:
-    description: 'Coverage format hint (auto, clover, cobertura, jacoco, lcov, istanbul, go). Auto-detects if not specified'
+    description: "Coverage format hint (auto, clover, cobertura, jacoco, lcov, istanbul, go). Auto-detects if not specified"
     required: false
-    default: 'auto'
+    default: "auto"
   disable-search:
     description: Disable automatic search for coverage files. Use with "files" input
     required: false
-    default: 'false'
+    default: "false"
 
   # Behavior flags (Codecov-style)
   fail-ci-if-error:
     description: Exit with non-zero code if coverage processing fails
     required: false
-    default: 'false'
+    default: "false"
   handle-no-reports-found:
     description: Do not fail if no coverage reports are found
     required: false
-    default: 'false'
+    default: "false"
   verbose:
     description: Enable verbose logging for debugging
     required: false
-    default: 'false'
+    default: "false"
 
   # Grouping and identification (Codecov-style)
   flags:
@@ -60,25 +63,25 @@ inputs:
   junit-xml-pattern:
     description: Glob pattern for finding JUnit XML files
     required: false
-    default: './**/*.junit.xml'
+    default: "./**/*.junit.xml"
   enable-tests:
     description: Enable test results reporting
     required: false
-    default: 'true'
+    default: "true"
   enable-coverage:
     description: Enable coverage reporting
     required: false
-    default: 'true'
+    default: "true"
   post-pr-comment:
     description: Post results as a PR comment (in addition to Job Summary)
     required: false
-    default: 'false'
+    default: "false"
 
   # Threshold enforcement
   fail-on-error:
     description: Fail the CI job if coverage thresholds are not met
     required: false
-    default: 'false'
+    default: "false"
   target-project:
     description: "Target project coverage % (or 'auto' to use base branch coverage)"
     required: false
@@ -91,7 +94,7 @@ inputs:
 
   # Legacy input (deprecated, use 'files' or 'directory' instead)
   coverage-xml-pattern:
-    description: '[Deprecated] Glob pattern for finding coverage XML files. Use files/directory instead.'
+    description: "[Deprecated] Glob pattern for finding coverage XML files. Use files/directory instead."
     required: false
 
 outputs:
@@ -112,7 +115,7 @@ outputs:
     description: Number of tests that changed from failing to passing
   tests-broken:
     description: Number of tests that changed from passing to failing
-  
+
   # Coverage outputs
   line-coverage:
     description: Line coverage percentage

package.json

@@ -1,7 +1,10 @@
 {
   "name": "codecov-action",
-  "version": "1.0.0",
+  "version": "0.0.0",
   "type": "module",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "rollup --config rollup.config.js",
     "format": "biome format --write .",