Skip to content

docs: troubleshooting, FORCE, Nx run, and CI ignore-scripts - #33

Merged
simoncrypta merged 3 commits into
08-09-fix_host_prune_stale__dev_shm_dirs_and_improve_quota_errorsfrom
08-09-docs_troubleshooting_force_nx_run_and_ci_ignore-scripts
Aug 10, 2026
Merged

docs: troubleshooting, FORCE, Nx run, and CI ignore-scripts#33
simoncrypta merged 3 commits into
08-09-fix_host_prune_stale__dev_shm_dirs_and_improve_quota_errorsfrom
08-09-docs_troubleshooting_force_nx_run_and_ci_ignore-scripts

Conversation

@simoncrypta

@simoncrypta simoncrypta commented Aug 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Document canonical Nx shape: db:ready (createAcquireTask + force) + cedarpg run --force.
  • Jest template example: set CEDAR_PG_FORCE=1 once in jest.config.js; prefer setupFilesAfterEnv.
  • Yarn Berry / YARN_ENABLE_SCRIPTS=false CI copy-paste for ci-install-autopg.sh.
  • Ephemeral /dev/shm sizing + leftover prune notes; new Troubleshooting table.
  • Fix alpha caveat version (0.1.0 → stable 1.0.0 / current 0.2.0-alpha.x).

Depends on #32 (stacked on #31).

Test plan

  • vp check
  • vp test tests/nx.test.ts
  • Skim README sections: Nx, CI, Jest template, Troubleshooting

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated Nx setup guidance with the recommended db:ready workflow and forced command execution.
    • Clarified database acquisition behavior, including concurrency precautions and programmatic configuration.
    • Added troubleshooting guidance for ephemeral hosts, CI installation, environment propagation, parallel targets, clone collisions, and external URLs.
    • Documented Jest template-mode setup, Yarn CI fallbacks, /dev/shm issues, and current alpha caveats.
    • Added a corresponding Unreleased changelog entry summarizing these updates.

Walkthrough

Changes

The documentation updates replace the Nx acquisition pattern with db:ready and forced cedarpg run commands. They also document Jest setup, CI installation fallback steps, ephemeral PostgreSQL cleanup, /dev/shm sizing, and troubleshooting cases.

Documentation workflows

Layer / File(s) Summary
Nx database workflow
README.md, src/adapters/nx.ts
Nx examples use a non-cached db:ready target, forced cedarpg run commands, and force: true acquisition.
Environment and troubleshooting guidance
README.md, CHANGELOG.md
Documentation covers Jest setup timing, CI binary installation, ephemeral PostgreSQL cleanup, /dev/shm sizing, and related troubleshooting cases.

Possibly related PRs

  • cedarjs/cedar-pg#31: Related Jest template-mode guidance covers setupFiles, setupFilesAfterEnv, and cloneWorkerDatabase.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Title check ✅ Passed The title clearly summarizes the documentation updates for troubleshooting, FORCE usage, Nx commands, and CI script settings.
Description check ✅ Passed The description directly explains the documentation changes and lists validation steps related to the pull request.

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 443: Update the README cleanup guidance and the automatic cold-start
pruning to scope deletion to resources owned by the current CI job, using a
job-specific directory or equivalent identifier for all /dev/shm paths. If that
cannot be enforced, explicitly state that the cleanup is only safe on an
isolated runner; apply the same safety scope to both manual commands and
automatic pruning.
- Around line 317-328: Update the “Yarn Berry / ignore-scripts consumers”
example to account for Plug’n’Play, either by explicitly limiting it to projects
using nodeLinker: node-modules or by resolving the `@cedarjs/pg` package path
through Yarn before invoking ci-install-autopg.sh.
- Around line 348-357: Update the README Jest lifecycle documentation around the
setupFilesAfterEnv configuration and troubleshooting entry to state that both
setupFiles and setupFilesAfterEnv run once per test file, including files
sharing a worker. Correct the cloneWorkerDatabase guidance to explain that its
module-level memo is not process-wide and the example may create one clone per
test file rather than one per worker.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2ef0c855-619e-4278-b076-795426ba2d5a

📥 Commits

Reviewing files that changed from the base of the PR and between 2062ece and 7a65112.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • README.md
  • src/adapters/nx.ts

Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
@simoncrypta
simoncrypta force-pushed the 08-09-docs_troubleshooting_force_nx_run_and_ci_ignore-scripts branch from 52d99f5 to 6ff2dcf Compare August 10, 2026 02:43
@simoncrypta
simoncrypta merged commit 0ad9a9c into main Aug 10, 2026
2 checks passed
@simoncrypta
simoncrypta deleted the 08-09-docs_troubleshooting_force_nx_run_and_ci_ignore-scripts branch August 10, 2026 02:46
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