@devries-cameron20 / composio Mirror · read-only
Fork 0

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, 07:15 UTC

next
md 83 lines 3.63 KB
Rendered Raw
1 # Bumping the Effect v4 pin
2
3 Adapted from the pre-migration prep work's stop-conditions, updated for the fact the
4 cutover is now done: this is a release-to-release upgrade procedure, not a v3→v4 port.
5
6 ## 1. Check `minimumReleaseAge`
7
8 `pnpm-workspace.yaml` sets `minimumReleaseAge: 4320` (minutes — 3 days) with an
9 explicit `minimumReleaseAgeExclude` list. A newly published release normally must
10 be at least 3 days old before pnpm will resolve it. For an explicitly requested release inside the cooldown, add temporary exclusions
11 for that exact version of the runtime and required satellites, including
12 `@effect/platform-node-shared`; do not exclude an entire package family.
13 Check the target version's npm publish timestamp
14 (`npm view effect@<version> time.<version>`) against `now - 4320m` before touching any
15 pin — bumping too early makes `pnpm install` fail to resolve, not silently ignore the
16 constraint.
17
18 ## 2. Bump the dependency ranges together
19
20 Every one of these must move to the same new range in the same change — never
21 upgrade one and leave the others behind:
22
23 - `pnpm-workspace.yaml` catalog: `effect`, `@effect/platform-bun`,
24 `@effect/vitest`.
25 - `ts/packages/cli-keyring/package.json`: its `effect` peer dependency uses an explicit
26 range (not `catalog:`); update that range too.
27 - Any other package pinning `effect` outside the catalog — grep for `"effect":` across
28 `ts/packages/*/package.json` before assuming the catalog covers everything.
29
30 The workspace currently uses `^4.1.0`. Use matching ranges for the runtime and
31 satellites, and keep the example-check matrix in `versions.json` on their exact
32 lockfile resolution.
33 Confirm the lockfile resolves matching versions.
34
35 ## 3. Advance the vendored source oracle
36
37 `ts/vendor/effect` is a git submodule pinned at a commit on the canonical
38 `Effect-TS/effect` repo, currently
39 `bc492f0965dc0f6a83cefd141071c5ead10f7efa` (tagged `effect@4.1.1`
40 at the time of writing — confirm with `git submodule status ts/vendor/effect`). Advance
41 it to the commit/tag matching the new npm version:
42
43 ```bash
44 cd ts/vendor/effect
45 git fetch --tags
46 git checkout <tag-or-commit-matching-the-new-effect-version>
47 cd -
48 git add ts/vendor/effect
49 ```
50
51 The submodule SHA and the npm version are two independent facts — record both, and
52 never treat "the vendored source moved" as license to bump the npm pin, or vice versa.
53 The vendored source is read-only: never edit it, never import runtime code from it.
54
55 ## 4. Install and verify
56
57 ```bash
58 pnpm install
59 pnpm typecheck
60 pnpm --filter @composio/cli test
61 pnpm --filter @composio/cli build
62 ```
63
64 Also run the CLI's Docker-based end-to-end suite (see the repo-local `cli-e2e` skill)
65 before treating the bump as done — a green typecheck is necessary but not sufficient;
66 CLI parsing, help rendering, and error output can change between releases while types stay
67 valid. Cross-check any API you touch during the bump against the freshly-advanced
68 `ts/vendor/effect/packages/effect/src` and the installed `effect` typings, not against
69 what compiled under the old release.
70
71 ## Stop conditions
72
73 Pause instead of reaching for a workaround when:
74
75 - the required behavior only exists on unreleased upstream `main` (no matching
76 published release yet);
77 - CLI help, parsing, output, error-rendering, or exit-code contracts change and cannot
78 be preserved with a like-for-like adaptation (see
79 [cli-surface.md](cli-surface.md) for what "preserved" means here);
80 - a package this repo depends on (`@effect/platform-bun`,
81 `@effect/vitest`) has no matching release published yet for the target `effect` version;
82 - the CLI's Docker E2E checks regress and the cause traces to the new release rather than
83 to this repo's own code.