@htekdev/actions-debugger 1.0.67 → 1.0.68

package/errors/caching-artifacts/artifact-retention-days-silently-capped-org-maximum.yml

@@ -0,0 +1,69 @@
+id: caching-artifacts-043
+title: "upload-artifact retention-days silently capped at organization maximum — artifact expires earlier than configured"
+category: caching-artifacts
+severity: silent-failure
+tags:
+  - upload-artifact
+  - retention-days
+  - artifacts
+  - organization-policy
+  - expiry
+patterns:
+  - regex: 'Artifact will be retained for \d+ days'
+    flags: "i"
+error_messages:
+  - "Artifact will be retained for"
+root_cause: |
+  When actions/upload-artifact is configured with a retention-days value that exceeds the
+  organization's or repository's maximum artifact retention setting, GitHub silently caps
+  the retention period to the configured maximum without emitting any error or warning.
+  The upload step completes successfully, the workflow shows green, and the artifact is
+  created — but it expires sooner than the workflow author intended.
+
+  This is particularly dangerous for:
+  - Compliance workflows that retain build artifacts for audits
+  - Release workflows where binaries must survive for customer download periods
+  - Security scanning workflows that need artifacts for post-incident review
+
+  The only way to discover the cap is to inspect the artifact's expiration date in the
+  repository's Actions UI after upload, or query the REST API. Developers who set
+  retention-days: 365 expecting one-year retention will find artifacts disappearing after
+  90 days (the default org maximum) with no log evidence of the cap.
+fix: |
+  Check your organization's artifact retention maximum under Organization Settings → Actions
+  → General → Artifact and log retention, and ensure retention-days in upload-artifact is
+  set to a value at or below this limit. If you need retention beyond the org maximum
+  (e.g., for compliance), use GitHub Releases for tagged builds, or an external artifact
+  store (S3, Azure Blob, GCS). You can also query the artifact API to assert the actual
+  expiry date and fail the workflow if it doesn't match expectations.
+fix_code:
+  - language: yaml
+    label: "Cap retention-days to org maximum and use GitHub Releases for long-term storage"
+    code: |
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-output-${{ github.sha }}
+          path: dist/
+          # Must be <= your org's maximum retention setting
+          # Check: Org Settings → Actions → General → Artifact and log retention
+          retention-days: 30
+
+      # For artifacts requiring retention beyond the org maximum (e.g., release binaries),
+      # attach them to a GitHub Release instead:
+      - name: Create GitHub Release with artifact
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: dist/**
+          # Release assets are NOT subject to the artifact retention policy
+prevention:
+  - "Check your organization's artifact retention maximum before setting retention-days in upload-artifact"
+  - "For artifacts requiring long-term storage, use GitHub Releases or an external object store (S3, GCS, Azure Blob)"
+  - "Add a workflow step that queries the artifact expiry via the REST API and fails if it doesn't match the intended retention"
+  - "Document the org retention limit in a comment next to retention-days to alert future editors"
+docs:
+  - url: "https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/storing-workflow-data-as-artifacts"
+    label: "Storing workflow data as artifacts — GitHub Docs"
+  - url: "https://docs.github.com/en/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization"
+    label: "Configuring artifact retention period for your organization — GitHub Docs"

package/errors/concurrency-timing/cancel-in-progress-deployment-environment-review-loop.yml

@@ -0,0 +1,76 @@
+id: concurrency-timing-036
+title: "cancel-in-progress: true cancels pending deployment environment reviews — deployment never completes"
+category: concurrency-timing
+severity: silent-failure
+tags:
+  - concurrency
+  - deployment
+  - environment
+  - cancel-in-progress
+  - required-reviewers
+patterns:
+  - regex: 'waiting for a required environment'
+    flags: "i"
+  - regex: 'Deployment to .+ was cancelled'
+    flags: "i"
+error_messages:
+  - "This workflow run is waiting for a required environment"
+  - "Deployment to production was cancelled"
+root_cause: |
+  When a deployment job targets an environment with required reviewers (protection rules)
+  and cancel-in-progress: true is set on the concurrency group, every new push cancels the
+  pending workflow run — including the one awaiting reviewer approval. The reviewer is
+  notified, starts the review process, but before they approve a new commit arrives and
+  cancels the run. The cycle repeats indefinitely: deployments queue, reviewers are
+  interrupted, and nothing ever reaches production. No diagnostic error is surfaced; the
+  workflow simply shows "Cancelled" with no indication that a required-reviewer gate was
+  involved.
+fix: |
+  Remove cancel-in-progress: true from the concurrency group used by the deployment job.
+  Use cancel-in-progress: false (the default) so pending approval runs survive new commits.
+  To still get fast feedback on CI, split the workflow into two separate files: a fast CI
+  workflow with cancel-in-progress: true, and a deployment workflow (triggered on CI success)
+  with cancel-in-progress: false so approval gates are preserved.
+fix_code:
+  - language: yaml
+    label: "Split CI and deploy workflows with separate concurrency policies"
+    code: |
+      # .github/workflows/ci.yml — cancel old CI runs freely
+      on: [push, pull_request]
+      concurrency:
+        group: ci-${{ github.ref }}
+        cancel-in-progress: true
+      jobs:
+        test:
+          runs-on: ubuntu-latest
+          steps:
+            - uses: actions/checkout@v4
+            - run: npm test
+
+      # .github/workflows/deploy.yml — preserve pending deployment approvals
+      on:
+        workflow_run:
+          workflows: [CI]
+          types: [completed]
+          branches: [main]
+      concurrency:
+        group: deploy-${{ github.ref }}
+        cancel-in-progress: false   # preserves pending required-reviewer approval
+      jobs:
+        deploy:
+          if: ${{ github.event.workflow_run.conclusion == 'success' }}
+          environment: production   # has required reviewers
+          runs-on: ubuntu-latest
+          steps:
+            - uses: actions/checkout@v4
+            - run: echo "Deploying..."
+prevention:
+  - "Never combine cancel-in-progress: true with deployment jobs that have required-reviewer environment protection rules"
+  - "Use separate workflow files for CI and deployment to apply different concurrency policies"
+  - "Set cancel-in-progress: false (or omit it) on any concurrency group that wraps a deployment environment job"
+  - "Test the deployment approval flow explicitly after adding or changing concurrency settings"
+docs:
+  - url: "https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-concurrency"
+    label: "Using concurrency — GitHub Docs"
+  - url: "https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-deployments/reviewing-deployments"
+    label: "Reviewing deployments — GitHub Docs"

package/errors/concurrency-timing/concurrency-group-missing-ref-cross-branch-cancellation.yml

@@ -0,0 +1,62 @@
+id: concurrency-timing-037
+title: "Concurrency group key missing github.ref accidentally cancels runs on other branches"
+category: concurrency-timing
+severity: silent-failure
+tags:
+  - concurrency
+  - cancel-in-progress
+  - github-ref
+  - branches
+  - cross-branch
+patterns:
+  - regex: 'cancelled because a more recent run with the same concurrency'
+    flags: "i"
+  - regex: 'This run was cancelled'
+    flags: "i"
+error_messages:
+  - "This run was cancelled because a more recent run with the same concurrency key is in progress"
+root_cause: |
+  When the concurrency group key is set to a static string or uses only github.workflow
+  without including github.ref, all branches share the same concurrency slot. A push to
+  any feature branch will cancel an in-progress run on main — or vice versa. With
+  cancel-in-progress: true, a developer's feature branch push can silently abort a
+  production branch deployment or a release CI run. The cancellation message ("This run
+  was cancelled because a more recent run with the same concurrency key is in progress")
+  gives no indication that the runs are on completely different branches. This is among the
+  most common misconfiguration in copy-pasted concurrency examples that omit github.ref.
+fix: |
+  Always include github.ref (or github.head_ref for pull_request events) in the concurrency
+  group key so each branch maintains its own independent concurrency slot. For pull requests,
+  use github.event.pull_request.number to prevent conflicts between simultaneously open PRs
+  targeting the same branch. For scheduled or manual workflows where github.ref is always
+  the same, use github.run_id to allow parallel runs.
+fix_code:
+  - language: yaml
+    label: "Include github.ref in the concurrency key to isolate each branch"
+    code: |
+      # WRONG — all branches share one concurrency slot, pushes to any branch
+      # cancel runs on all other branches
+      # concurrency:
+      #   group: ${{ github.workflow }}
+      #   cancel-in-progress: true
+
+      # CORRECT — each branch has its own independent concurrency slot
+      concurrency:
+        group: ${{ github.workflow }}-${{ github.ref }}
+        cancel-in-progress: true
+
+      # For pull_request events, scope to the PR number for extra precision
+      # (prevents PR-A and PR-B from cancelling each other when both target main)
+      concurrency:
+        group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+        cancel-in-progress: true
+prevention:
+  - "Always include github.ref or github.head_ref in the concurrency group key"
+  - "For pull_request workflows, use github.event.pull_request.number || github.ref to scope to individual PRs"
+  - "Audit all workflow concurrency keys whenever enabling cancel-in-progress: true"
+  - "Use a unique prefix per workflow type (ci-, deploy-, lint-) to prevent cross-workflow collisions even when github.ref is included"
+docs:
+  - url: "https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-concurrency"
+    label: "Using concurrency — GitHub Docs"
+  - url: "https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#concurrency"
+    label: "Concurrency syntax — GitHub Docs"

package/errors/yaml-syntax/run-block-scalar-folded-gt-collapses-newlines.yml

@@ -0,0 +1,76 @@
+id: yaml-syntax-044
+title: "run: > (folded block scalar) collapses newlines to spaces — multi-line shell scripts break silently"
+category: yaml-syntax
+severity: error
+tags:
+  - yaml
+  - run
+  - block-scalar
+  - multiline
+  - shell
+  - folded
+patterns:
+  - regex: 'syntax error near unexpected token'
+    flags: "i"
+  - regex: 'command not found'
+    flags: "i"
+  - regex: 'unexpected EOF while looking for matching'
+    flags: "i"
+error_messages:
+  - "syntax error near unexpected token"
+  - "command not found"
+  - "unexpected EOF while looking for matching `\"'"
+root_cause: |
+  YAML has two block scalar indicators: | (literal) preserves newlines exactly, while >
+  (folded) collapses newlines between non-empty lines into a single space. When a GitHub
+  Actions run: block uses > instead of |, every line break in the shell script becomes a
+  space. Multi-line scripts are silently concatenated into a single command that the shell
+  cannot parse, producing confusing errors like "syntax error near unexpected token" or
+  "command not found" pointing to the wrong line.
+
+  This is especially common when:
+  - Developers copy YAML examples from documentation that use > for prose (not scripts)
+  - IDEs or formatters suggest > to reduce visual indentation
+  - Developers confuse > (folded) and | (literal) because both produce multi-line blocks
+
+  Example: a three-line script becomes one run-together line:
+    # With run: >       becomes: echo "start"   VAR=hello   echo "$VAR"
+    # With run: |       becomes: echo "start" \n VAR=hello \n echo "$VAR"  (correct)
+fix: |
+  Always use | (pipe / literal block scalar) for run: steps that contain shell scripts.
+  The | indicator preserves newlines exactly as written. The > indicator should only be
+  used for prose strings (e.g., long error messages or descriptions) where newline
+  collapsing is intentional.
+fix_code:
+  - language: yaml
+    label: "Use | (literal) not > (folded) for run: shell scripts"
+    code: |
+      jobs:
+        build:
+          runs-on: ubuntu-latest
+          steps:
+            # WRONG — > folds newlines into spaces, script becomes one broken command
+            # - name: Build
+            #   run: >
+            #     echo "Starting build"
+            #     npm install
+            #     npm run build
+
+            # CORRECT — | preserves newlines, each command runs on its own line
+            - name: Build
+              run: |
+                echo "Starting build"
+                npm install
+                npm run build
+prevention:
+  - "Always use | (literal block scalar) for run: blocks containing shell scripts"
+  - "Reserve > (folded block scalar) for non-executable prose strings only"
+  - "Enable a YAML linter (e.g., actionlint, yamllint) in pre-commit hooks to catch > in run: blocks"
+  - "When in doubt: | keeps lines as lines; > joins lines with spaces"
+docs:
+  - url: "https://yaml.org/spec/1.2.2/#chapter-8-block-style-productions"
+    label: "YAML block scalar styles — YAML spec"
+  - url: "https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun"
+    label: "jobs.<id>.steps[*].run — GitHub Docs"
+  - url: "https://rhysd.github.io/actionlint/"
+    label: "actionlint — static checker for GitHub Actions workflow files"

package/package.json

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