docs(effect-ts): skip prepare setup in CI#1
Open
altaywtf wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
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
preparelifecycle script. - Replaces the example
preparescript entry withsetup:effectand 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.
966aec8 to
9f2dfa8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Update the Effect source setup guide so the local clone
preparehelper exits whenCI=true. This keeps the current local setup ergonomics while avoiding unexpected.repos/effectclones in CI/CD automation workspaces.Changed
CI=trueguard to the concretescripts/prepare-effect.shshape..repos/effectwhen running under CI.Risks
Low. This is documentation-only, but it changes the recommended script shape for option 3.
Verification
git diff --checkComplexity
Reduced: keeps local automatic setup while avoiding CI/CD side effects.