Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
| 1 | # Changelog Guide |
| 2 | |
| 3 | ## File Naming |
| 4 | |
| 5 | ``` |
| 6 | MM-DD-YY.mdx # e.g., 12-29-25.mdx |
| 7 | MM-DD-YY-suffix.mdx # Multiple same day: 12-10-25-masking.mdx |
| 8 | ``` |
| 9 | |
| 10 | ## Template |
| 11 | |
| 12 | ```mdx |
| 13 | --- |
| 14 | title: "Your Title Here" |
| 15 | date: "YYYY-MM-DD" |
| 16 | --- |
| 17 | |
| 18 | Brief intro paragraph. |
| 19 | |
| 20 | ### SDK Versions (if applicable) |
| 21 | |
| 22 | | SDK | Version | |
| 23 | |-----|---------| |
| 24 | | Python `composio` | `0.10.2` | |
| 25 | | TypeScript `@composio/core` | `0.3.1` | |
| 26 | |
| 27 | ### Breaking Changes (if applicable) |
| 28 | |
| 29 | <Callout type="warn"> |
| 30 | **Breaking Change** |
| 31 | |
| 32 | What breaks and why. |
| 33 | </Callout> |
| 34 | |
| 35 | **Before:** |
| 36 | \`\`\`python |
| 37 | old_code() |
| 38 | \`\`\` |
| 39 | |
| 40 | **After:** |
| 41 | \`\`\`python |
| 42 | new_code() |
| 43 | \`\`\` |
| 44 | |
| 45 | ### What's New / Improvements / Bug Fixes |
| 46 | |
| 47 | - Change 1 |
| 48 | - Change 2 |
| 49 | ``` |
| 50 | |
| 51 | Use the released version in the final table column. The Python release guard reads that column from rows labelled `Python \`composio\``. |
| 52 | |
| 53 | ## SDK release entries |
| 54 | |
| 55 | The SDK release workflow writes one entry per release to `docs/content/changelog/`, with `sdkRelease` and `sdkReleaseTargets` frontmatter, the version table, the changeset summaries, and a link to the request issue. Its prose comes from the changesets: to change it, fix the changesets on `next` and request a new release. Do not hand-edit generated entries in the release PR. |
| 56 | |
| 57 | The release PR also regenerates `docs/content/reference/sdk-reference/` from the released source. Changelog code fences are not type-checked, because they may describe APIs newer than the docs pins; the docs pin PR that follows each release keeps maintained guides checked against the released types. |
| 58 | |
| 59 | ## Rules |
| 60 | |
| 61 | 1. **Frontmatter required** — `title` and `date` (YYYY-MM-DD format) |
| 62 | 2. **No `#` heading** — Title renders automatically from frontmatter |
| 63 | 3. **Use `###` for sections** — Content headings start at h3 |
| 64 | 4. **No emojis** — No checkmarks, warning symbols, etc. |
| 65 | |
| 66 | ## Change Types |
| 67 | |
| 68 | | Type | How to Format | |
| 69 | |------|---------------| |
| 70 | | Breaking Change | `<Callout type="warn">` + before/after code + migration guide | |
| 71 | | New Feature | `### What's New` | |
| 72 | | Improvement | `### Improvements` | |
| 73 | | Bug Fix | `### Bug Fixes` | |
| 74 | | Deprecation | `<Callout>` with timeline | |
| 75 | |
| 76 | ## Breaking Changes Checklist |
| 77 | |
| 78 | For any breaking change, include: |
| 79 | - [ ] Before/after code examples |
| 80 | - [ ] Migration guide with step-by-step instructions |
| 81 | - [ ] Codemod (if applicable) — automated script to transform old code to new |
| 82 | |
| 83 | **What's a codemod?** A script that automatically updates user code. Instead of "change X to Y manually", users run the codemod and it transforms their code. See [jscodeshift](https://github.com/facebook/jscodeshift) or [ts-morph](https://github.com/dsherret/ts-morph). |
| 84 | |
| 85 | Changesets summaries are authored Markdown that becomes MDX. Put prose type syntax such as `Array<Tool>` in code spans so it does not parse as an unclosed JSX element. The production docs build validates the generated entry before release approval. |