Skip to content

docs: add the DEPLOY namespace to the error reference - #377

Open
quicksilversel wants to merge 1 commit into
prisma:mainfrom
quicksilversel:docs/deploy-error-namespace
Open

quicksilversel wants to merge 1 commit into
prisma:mainfrom
quicksilversel:docs/deploy-error-namespace

Conversation

@quicksilversel

Copy link
Copy Markdown

Every DEPLOY.* error prints a docsUrl that resolves to this page, but the page had no DEPLOY section, so the links dead-ended. Hit in practice through DEPLOY.PREFLIGHT_FAILED (prisma/composer#394), whose printed docs link leads nowhere.

  • docs/reference/error-reference.md: a DEPLOY row in the namespace table and a DEPLOY section between CLI and DEV, with one entry per code the mounted Composer family raises (14 codes, enumerated from @prisma/composer and @prisma/composer-prisma-cloud 0.35.0). Entry text follows each envelope's own message, why and fix fields, and the format mirrors the existing family-maintained DEV entries.

Validation

  • Markdown-only change. pnpm check:error-reference verifies codes from this repository's source, so added family entries do not affect it.

The deploy pipeline's errors print docsUrls that point at this page, but
the page had no DEPLOY section, so every such link dead-ended. Adds the
namespace table row and one entry per code the mounted Composer family
raises, with text taken from the envelopes' own message, why and fix fields.

Signed-off-by: quicksilversel <quicksilversel@gmail.com>
@coderabbitai

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 372bd557-d104-4fc6-bd0c-3e91d7bc6eab
Commits

Reviewing files that changed from the base of the PR and between dc78ac7 and 8549d6d.

Files selected for processing: 1
  • docs/reference/error-reference.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Summary by CodeRabbit

  • Documentation
    • Expanded the error reference with deployment and teardown error codes, covering configuration, runtime, validation, and pipeline failures.
    • Added the deployment error namespace to the namespace table.

Walkthrough

The error reference adds the DEPLOY namespace to its namespace table. It describes the pipeline shared by Composer deploy and destroy operations and documents 14 error codes for dependency, configuration, container, engine, preflight, stage, target, teardown, and unexpected pipeline errors.

Priority: Low

Merge Risk: Minimal · up to 8549d

The change documents DEPLOY errors without changing runtime behavior. No actionable merge-blocking issue is established.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title names the change: adding a DEPLOY namespace to the error reference doc. The raw summary confirms the namespace row, the DEPLOY section, and the 14 documented codes all match this title. The …
Description check Passed The description explains the problem and the change. DEPLOY.* errors print a docsUrl that resolves to this page, but the page lacked a DEPLOY section. It states the change adds a namespace table row a…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the change: adding a DEPLOY namespace to the error reference doc. The raw summary confirms the namespace row, the DEPLOY section, and the 14 documented codes all match this title. The title is specific and short, and it uses the docs: prefix convention.

Full details: Description check

Explanation

The description explains the problem and the change. DEPLOY.* errors print a docsUrl that resolves to this page, but the page lacked a DEPLOY section. It states the change adds a namespace table row and a DEPLOY section with 14 codes, and that the change is Markdown-only. This matches the changeset described in the raw summary.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
✨ Simplify code
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant