Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 06:00 UTC
Bumping the Effect v4 pin
Adapted from the pre-migration prep work's stop-conditions, updated for the fact the cutover is now done: this is a release-to-release upgrade procedure, not a v3→v4 port.
1. Check minimumReleaseAge
pnpm-workspace.yaml sets minimumReleaseAge: 4320 (minutes — 3 days) with an
explicit minimumReleaseAgeExclude list. A newly published release normally must
be at least 3 days old before pnpm will resolve it. For an explicitly requested release inside the cooldown, add temporary exclusions
for that exact version of the runtime and required satellites, including
@effect/platform-node-shared; do not exclude an entire package family.
Check the target version's npm publish timestamp
(npm view effect@<version> time.<version>) against now - 4320m before touching any
pin — bumping too early makes pnpm install fail to resolve, not silently ignore the
constraint.
2. Bump the dependency ranges together
Every one of these must move to the same new range in the same change — never upgrade one and leave the others behind:
pnpm-workspace.yamlcatalog:effect,@effect/platform-bun,@effect/vitest.ts/packages/cli-keyring/package.json: itseffectpeer dependency uses an explicit range (notcatalog:); update that range too.- Any other package pinning
effectoutside the catalog — grep for"effect":acrossts/packages/*/package.jsonbefore assuming the catalog covers everything.
The workspace currently uses ^4.1.0. Use matching ranges for the runtime and
satellites, and keep the example-check matrix in versions.json on their exact
lockfile resolution.
Confirm the lockfile resolves matching versions.
3. Advance the vendored source oracle
ts/vendor/effect is a git submodule pinned at a commit on the canonical
Effect-TS/effect repo, currently
bc492f0965dc0f6a83cefd141071c5ead10f7efa (tagged effect@4.1.1
at the time of writing — confirm with git submodule status ts/vendor/effect). Advance
it to the commit/tag matching the new npm version:
cd ts/vendor/effect
git fetch --tags
git checkout <tag-or-commit-matching-the-new-effect-version>
cd -
git add ts/vendor/effect
The submodule SHA and the npm version are two independent facts — record both, and never treat "the vendored source moved" as license to bump the npm pin, or vice versa. The vendored source is read-only: never edit it, never import runtime code from it.
4. Install and verify
pnpm install
pnpm typecheck
pnpm --filter @composio/cli test
pnpm --filter @composio/cli build
Also run the CLI's Docker-based end-to-end suite (see the repo-local cli-e2e skill)
before treating the bump as done — a green typecheck is necessary but not sufficient;
CLI parsing, help rendering, and error output can change between releases while types stay
valid. Cross-check any API you touch during the bump against the freshly-advanced
ts/vendor/effect/packages/effect/src and the installed effect typings, not against
what compiled under the old release.
Stop conditions
Pause instead of reaching for a workaround when:
- the required behavior only exists on unreleased upstream
main(no matching published release yet); - CLI help, parsing, output, error-rendering, or exit-code contracts change and cannot be preserved with a like-for-like adaptation (see cli-surface.md for what "preserved" means here);
- a package this repo depends on (
@effect/platform-bun,@effect/vitest) has no matching release published yet for the targeteffectversion; - the CLI's Docker E2E checks regress and the cause traces to the new release rather than to this repo's own code.