Skip to content

docs(effect-ts): skip prepare setup in CI#1

Open
altaywtf wants to merge 2 commits into
Effect-TS:mainfrom
altaywtf:avoid-effect-prepare-lifecycle
Open

docs(effect-ts): skip prepare setup in CI#1
altaywtf wants to merge 2 commits into
Effect-TS:mainfrom
altaywtf:avoid-effect-prepare-lifecycle

Conversation

@altaywtf

@altaywtf altaywtf commented May 16, 2026

Copy link
Copy Markdown

Summary

Update the Effect source setup guide so the local clone prepare helper exits when CI=true. This keeps the current local setup ergonomics while avoiding unexpected .repos/effect clones in CI/CD automation workspaces.

Changed

  • Document that option 3 bootstraps the clone only outside CI.
  • Add the CI=true guard to the concrete scripts/prepare-effect.sh shape.
  • Note that install, pack, publish, or CI/CD flows should not clone .repos/effect when running under CI.

Risks

Low. This is documentation-only, but it changes the recommended script shape for option 3.

Verification

  • git diff --check

Complexity

Reduced: keeps local automatic setup while avoiding CI/CD side effects.

Copilot AI review requested due to automatic review settings May 16, 2026 10:33

Copilot AI 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.

Pull request overview

Updates the Effect source setup documentation to avoid using package-manager lifecycle hooks (e.g., prepare) for cloning the local Effect repo, replacing it with an explicit setup:effect task to prevent unintended clones during install/CI/pack/publish flows.

Changes:

  • Renames the “local clone” option to use an explicit setup task rather than a prepare lifecycle script.
  • Replaces the example prepare script entry with setup:effect and updates the referenced shell script name accordingly.
  • Adds explicit guidance warning against wiring this helper to lifecycle hooks like prepare/postinstall.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@altaywtf altaywtf force-pushed the avoid-effect-prepare-lifecycle branch from 966aec8 to 9f2dfa8 Compare May 16, 2026 10:35
@altaywtf altaywtf changed the title docs(effect-ts): avoid prepare lifecycle setup docs(effect-ts): skip prepare setup in CI May 16, 2026
@altaywtf altaywtf requested a review from Copilot May 16, 2026 10:37

Copilot AI 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.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread skills/effect-ts/references/setup.md Outdated
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.

2 participants