@htekdev/actions-debugger 1.0.43 → 1.0.44

package/errors/known-unsolved/environment-matrix-one-review-per-job.yml

@@ -0,0 +1,100 @@
+id: known-unsolved-034
+title: 'environment deployment protection with required reviewers creates one review request per matrix job — no batch approval'
+category: known-unsolved
+severity: limitation
+tags:
+  - environment
+  - matrix
+  - deployment
+  - required-reviewers
+  - approvals
+  - no-fix
+patterns:
+  - regex: 'Waiting for.*review'
+    flags: 'i'
+  - regex: 'Review required before this job runs'
+    flags: 'i'
+error_messages:
+  - 'Waiting for a reviewer'
+  - 'Review required before this job runs'
+root_cause: |
+  GitHub Actions environments with required reviewers enforce approval at the
+  individual job level. When a job using environment: with required reviewers
+  also uses strategy: matrix, each matrix cell creates a separate deployment
+  instance requiring its own approval.
+
+  A 3x3 matrix (os x environment) produces 9 separate "Waiting for reviewer"
+  prompts in the GitHub Actions UI — one for each matrix combination. Each
+  must be approved individually; there is no "approve all" button for
+  matrix deployments.
+
+  This behavior stems from GitHub's deployment model: each job run creates a
+  discrete deployment record in the repository's deployment history. Matrix
+  jobs are independent job runs, so each creates its own deployment record
+  and independently triggers the environment protection review gate.
+
+  This is confirmed expected behavior per GitHub staff in community discussions.
+  There is no configuration option to batch or group matrix job deployment approvals.
+fix: |
+  There is no supported way to batch-approve matrix jobs targeting a protected
+  environment. The workaround is architectural: separate the build/test matrix
+  from the deployment job, using a single non-matrix deploy job that depends
+  on all matrix results via needs:.
+
+  This "build in matrix, deploy once" pattern also aligns with security best
+  practice — production deployments should be a single auditable event.
+fix_code:
+  - language: yaml
+    label: 'Anti-pattern — matrix job with protected environment (creates N review requests)'
+    code: |
+      jobs:
+        deploy:
+          strategy:
+            matrix:
+              region: [us-east-1, eu-west-1, ap-southeast-1]
+          environment: production   # 3 separate review requests
+          runs-on: ubuntu-latest
+          steps:
+            - run: echo "deploying to ${{ matrix.region }}"
+  - language: yaml
+    label: 'Workaround — single non-matrix deploy job collects matrix artifacts and deploys once'
+    code: |
+      jobs:
+        build:
+          strategy:
+            matrix:
+              region: [us-east-1, eu-west-1, ap-southeast-1]
+          runs-on: ubuntu-latest
+          steps:
+            - uses: actions/checkout@v4
+            - name: Build for region
+              run: make build REGION=${{ matrix.region }}
+            - uses: actions/upload-artifact@v4
+              with:
+                name: build-${{ matrix.region }}
+                path: dist/
+
+        deploy:
+          needs: build
+          runs-on: ubuntu-latest
+          environment: production   # Single review request for all regions
+          steps:
+            - uses: actions/download-artifact@v4
+              with:
+                pattern: build-*
+                merge-multiple: true
+                path: all-dist/
+            - name: Deploy all regions
+              run: make deploy-all ARTIFACTS_DIR=all-dist/
+prevention:
+  - 'Design deployment workflows so the job with environment: protection is never a matrix job'
+  - 'Use build-in-matrix, deploy-once pattern: matrix for build/test, single serial job for protected deploy'
+  - 'If per-region deployments must be parallel and require environment protection, accept the N-approvals UX'
+  - 'Document this limitation in team runbooks before adopting matrix + environment patterns in production pipelines'
+docs:
+  - url: 'https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment'
+    label: 'GitHub Docs — Managing environments for deployment'
+  - url: 'https://github.com/orgs/community/discussions/15690'
+    label: 'GitHub Community — Matrix deployment creates multiple approval requests'
+  - url: 'https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-a-matrix-for-your-workflow'
+    label: 'GitHub Docs — Using a matrix for your workflow'

package/errors/permissions-auth/attest-build-provenance-missing-attestations-write.yml

@@ -0,0 +1,100 @@
+id: permissions-auth-035
+title: 'actions/attest-build-provenance fails with 403 — missing attestations: write permission'
+category: permissions-auth
+severity: error
+tags:
+  - attestations
+  - attest-build-provenance
+  - GITHUB_TOKEN
+  - permissions
+  - 403
+  - supply-chain
+patterns:
+  - regex: 'HttpError.*403.*attestation'
+    flags: 'i'
+  - regex: 'Resource not accessible by integration'
+    flags: 'i'
+  - regex: 'Failed to create attestation'
+    flags: 'i'
+error_messages:
+  - 'HttpError: 403 — Resource not accessible by integration'
+  - 'Failed to create attestation'
+  - 'Error: Resource not accessible by integration'
+root_cause: |
+  actions/attest-build-provenance (introduced GitHub Changelog, May 2024) requires
+  the GITHUB_TOKEN to have the attestations: write scope. This permission did not
+  exist before the attestations feature was released and is NOT included in the
+  GitHub Actions default token permissions, nor in commonly used broad permission
+  sets like contents: write or id-token: write.
+
+  When the workflow omits attestations: write from its permissions block, the
+  action fails with a 403 "Resource not accessible by integration" error. The
+  error message does not explicitly mention "attestations: write" as the missing
+  scope, making the root cause difficult to identify.
+
+  Common mistake: developers copy the attest-build-provenance action from
+  documentation examples or third-party tutorials that may not include the full
+  permissions block, or they use a minimal permissions block that covers other
+  needs (contents: read, packages: write) without adding attestations: write.
+
+  Organization policy note: if the organization has disabled the attestations
+  feature, even a correctly-permissioned workflow will fail. Check org-level
+  Actions settings under Settings > Actions > General.
+fix: |
+  Add attestations: write to the permissions block of the job (or workflow)
+  that runs actions/attest-build-provenance. If using OIDC for cloud auth,
+  id-token: write is also required for the attestation signature.
+fix_code:
+  - language: yaml
+    label: 'Add attestations: write to job permissions'
+    code: |
+      jobs:
+        build:
+          runs-on: ubuntu-latest
+          permissions:
+            contents: read
+            attestations: write   # Required for attest-build-provenance
+            id-token: write       # Required for OIDC-based attestation signing
+          steps:
+            - uses: actions/checkout@v4
+
+            - name: Build artifact
+              run: make build
+
+            - uses: actions/attest-build-provenance@v2
+              with:
+                subject-path: dist/my-artifact
+  - language: yaml
+    label: 'Container registry publish with attestation'
+    code: |
+      jobs:
+        publish:
+          runs-on: ubuntu-latest
+          permissions:
+            contents: read
+            packages: write
+            attestations: write   # Required
+            id-token: write       # Required
+          steps:
+            - uses: actions/checkout@v4
+            - uses: docker/build-push-action@v6
+              id: push
+              with:
+                push: true
+                tags: ghcr.io/${{ github.repository }}:latest
+            - uses: actions/attest-build-provenance@v2
+              with:
+                subject-name: ghcr.io/${{ github.repository }}
+                subject-digest: ${{ steps.push.outputs.digest }}
+prevention:
+  - 'Always include both attestations: write and id-token: write when using attest-build-provenance'
+  - 'Check action release notes when adding actions that use newer GitHub platform features'
+  - 'The missing scope is not always named in 403 error messages — cross-reference the action docs for required permissions'
+  - 'Enable required_workflows or org-level policies to verify attestation is permitted before deploying'
+docs:
+  - url: 'https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds'
+    label: 'GitHub Docs — Using artifact attestations to establish provenance'
+  - url: 'https://github.com/actions/attest-build-provenance'
+    label: 'actions/attest-build-provenance repository'
+  - url: 'https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token'
+    label: 'GitHub Docs — Controlling permissions for GITHUB_TOKEN'

package/errors/runner-environment/setup-python-version-range-resolves-to-313-distutils-removed.yml

@@ -0,0 +1,107 @@
+id: runner-environment-099
+title: "setup-python python-version '3' resolves to Python 3.13 — distutils and other removed modules cause ImportError"
+category: runner-environment
+severity: error
+tags:
+  - setup-python
+  - python-3-13
+  - distutils
+  - breaking-change
+  - version-pinning
+patterns:
+  - regex: 'ModuleNotFoundError.*distutils'
+    flags: 'i'
+  - regex: 'No module named .distutils.'
+    flags: 'i'
+  - regex: 'ImportError.*distutils'
+    flags: 'i'
+error_messages:
+  - "ModuleNotFoundError: No module named 'distutils'"
+  - "No module named 'distutils'"
+  - "error: can't find distutils"
+root_cause: |
+  Python 3.12 moved distutils into setuptools (no longer stdlib), and Python 3.13
+  fully removed it from the standard library (PEP 632, deprecated since 3.10).
+
+  GitHub Actions workflows using a floating python-version constraint:
+    python-version: '3'
+    python-version: '3.x'
+    python-version: 'latest'
+  ...resolved to Python 3.13 when it became the latest stable release (October 2024).
+  Runner images updated to include 3.13 as the available version for these constraints.
+
+  Any project that imports distutils directly (setup.py, older NumPy, Cython, some
+  SWIG bindings) or tools that internally import it will fail with:
+    ModuleNotFoundError: No module named 'distutils'
+
+  Additional modules removed in Python 3.12-3.13 that break CI:
+  - cgi, imghdr (removed 3.13)
+  - aifc, sunau, chunk, crypt (removed 3.13)
+  - imp module (removed 3.12)
+  - asynchat, asyncore (removed 3.12)
+
+  The failure is from the floating version constraint resolving higher than intended,
+  not from the runner image itself. Pinned workflows on 3.11 or 3.12 are unaffected.
+fix: |
+  Pin python-version to a specific minor version instead of using a floating
+  constraint. If distutils is required, use the setuptools-provided shim.
+
+  Migration options for distutils usage:
+  - Replace distutils.core.setup with setuptools.setup
+  - Replace distutils.util.strtobool with a custom bool parser
+  - Replace distutils.version.LooseVersion with packaging.version.Version
+  - Install setuptools on Python 3.13 to restore the distutils shim
+fix_code:
+  - language: yaml
+    label: 'Pin to specific minor version to avoid 3.13+ resolution'
+    code: |
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'   # Pinned — won't resolve to 3.13+
+          # OR: '3.12'  (distutils still available via setuptools shim)
+  - language: yaml
+    label: 'Use setuptools shim on Python 3.13'
+    code: |
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - name: Install setuptools for distutils compatibility
+        run: pip install setuptools   # Restores distutils shim on 3.13+
+  - language: yaml
+    label: 'Pin version via .python-version file'
+    code: |
+      # .python-version file in repo root:
+      # 3.11.9
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: '.python-version'   # Reads from repo file
+  - language: yaml
+    label: 'Matrix across versions to catch breakage early'
+    code: |
+      jobs:
+        test:
+          strategy:
+            matrix:
+              python-version: ['3.11', '3.12', '3.13']
+          steps:
+            - uses: actions/setup-python@v5
+              with:
+                python-version: ${{ matrix.python-version }}
+            - run: pip install setuptools   # Shim for 3.13
+            - run: pip install -e .
+            - run: pytest
+prevention:
+  - 'Never use python-version: 3 or python-version: 3.x in production workflows without testing each new minor release'
+  - 'Pin to a specific minor version (3.11, 3.12) or use a .python-version file in the repo'
+  - 'Run CI on a matrix of python versions to catch version-specific breakage early'
+  - 'Audit setup.py for direct distutils imports and replace with setuptools equivalents before upgrading to 3.13'
+docs:
+  - url: 'https://docs.python.org/3/whatsnew/3.13.html#removed-modules'
+    label: 'Python 3.13 — Removed Modules'
+  - url: 'https://peps.python.org/pep-0632/'
+    label: 'PEP 632 — Deprecate distutils'
+  - url: 'https://github.com/actions/setup-python'
+    label: 'actions/setup-python repository'
+  - url: 'https://docs.github.com/en/actions/use-cases-and-examples/building-and-testing/building-and-testing-python'
+    label: 'GitHub Docs — Building and testing Python'

package/errors/silent-failures/github-output-heredoc-delimiter-collision.yml

@@ -0,0 +1,83 @@
+id: silent-failures-049
+title: 'GITHUB_OUTPUT multiline heredoc value silently truncated when content contains the delimiter string'
+category: silent-failures
+severity: silent-failure
+tags:
+  - GITHUB_OUTPUT
+  - multiline
+  - heredoc
+  - delimiter-collision
+  - environment-files
+patterns:
+  - regex: 'echo\s+\"\w+<<EOF\"'
+    flags: 'i'
+error_messages: []
+root_cause: |
+  GitHub Actions environment files (GITHUB_OUTPUT, GITHUB_ENV, GITHUB_STEP_SUMMARY)
+  use a heredoc-style syntax for multiline values:
+
+    echo "BODY<<EOF" >> $GITHUB_OUTPUT
+    echo "first line" >> $GITHUB_OUTPUT
+    echo "second line" >> $GITHUB_OUTPUT
+    echo "EOF" >> $GITHUB_OUTPUT
+
+  If the multiline content itself contains the exact delimiter string ("EOF" in
+  the example above) on a line by itself, the runner stops reading at that point
+  and silently truncates the value. No error is raised and the step exits 0.
+
+  Common scenarios:
+  1. A release body or commit message that happens to contain "EOF" on its own line.
+  2. A generated file that includes shell script snippets (which often use EOF).
+  3. A changelog that uses EOF as a delimiter in a code example.
+
+  The delimiter collision causes the output variable to contain only the content
+  up to (but not including) the first occurrence of the delimiter string, with
+  no indication that truncation occurred.
+fix: |
+  Use a randomly-generated or sufficiently unique delimiter that will not
+  appear in the content. Common approaches:
+
+  1. Generate a UUID or random hex string at runtime and use it as the delimiter.
+  2. Use a very long, unusual string that is unlikely to appear in content.
+
+  The GitHub documentation explicitly recommends a random delimiter to avoid
+  this collision:
+    https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#multiline-strings
+fix_code:
+  - language: yaml
+    label: 'Unsafe — static delimiter may collide with content'
+    code: |
+      - name: Set multiline output (unsafe)
+        run: |
+          echo "BODY<<EOF" >> $GITHUB_OUTPUT
+          echo "${{ steps.notes.outputs.content }}" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+  - language: yaml
+    label: 'Safe — random delimiter prevents collision'
+    code: |
+      - name: Set multiline output (safe random delimiter)
+        run: |
+          DELIM="ghadelim_$(head -c 16 /dev/urandom | base64 | tr -dc 'a-zA-Z0-9' | head -c 16)"
+          echo "BODY<<${DELIM}" >> $GITHUB_OUTPUT
+          echo "${{ steps.notes.outputs.content }}" >> $GITHUB_OUTPUT
+          echo "${DELIM}" >> $GITHUB_OUTPUT
+  - language: yaml
+    label: 'Windows — PowerShell random delimiter'
+    code: |
+      - name: Set multiline output (PowerShell)
+        shell: pwsh
+        run: |
+          $delim = "ghadelim_$([System.Guid]::NewGuid().ToString('N').Substring(0, 16))"
+          "BODY<<$delim" | Out-File -FilePath $env:GITHUB_OUTPUT -Append -Encoding utf8
+          $releaseNotes | Out-File -FilePath $env:GITHUB_OUTPUT -Append -Encoding utf8
+          $delim | Out-File -FilePath $env:GITHUB_OUTPUT -Append -Encoding utf8
+prevention:
+  - 'Never use a simple static delimiter like EOF, END, or DONE for multiline GITHUB_OUTPUT values'
+  - 'Always use a random or UUID-based delimiter when the content could be dynamic or user-provided'
+  - 'Test multiline output steps with content that deliberately contains common delimiter strings'
+  - 'GitHub docs recommend randomly generated delimiters for all multiline environment file writes'
+docs:
+  - url: 'https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#multiline-strings'
+    label: 'GitHub Docs — Workflow commands: multiline strings'
+  - url: 'https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables'
+    label: 'GitHub Docs — Store information in variables'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@htekdev/actions-debugger",
-  "version": "1.0.43",
+  "version": "1.0.44",
   "description": "65+ real GitHub Actions errors, queryable by agents. CLI + MCP server + Copilot skills + error database.",
   "type": "module",
   "main": "./dist/index.js",