Repo

bumpgen bumps your **TypeScript / TSX** dependencies and makes code changes for you if anything breaks.
Here's a common scenario:
> you: "I should upgrade to the latest version of x, it has banging new features and impressive performance improvements"
>
> you (5 minutes later): _nevermind, that broke a bunch of stuff_
Then use bumpgen!
**How does it work?**
- bumpgen builds your project to understand what broke when a dependency was bumped
- Then bumpgen uses ts-morph to create an _abstract syntax tree_ from your code, to understand the relationships between statements
- It also uses the AST to get type definitions for external methods to understand how to use new package versions
- bumpgen then creates a _plan graph_ DAG to execute things in the correct order to handle propagating changes (ref: arxiv 2309.12499)
> [!NOTE]
> bumpgen only supports typescript and tsx at the moment, but we're working on adding support for other strongly typed languages. Hit the emoji button on our open issues for Java, golang, C# and Python to request support.
🚀 Get Started
To get started, you'll need an OpenAI API key. gpt-4-turbo-preview from OpenAI is the only supported model at this time, though we plan on supporting more soon.
Then, run bumpgen:
where @tanstack/react-query is the package you want to bump and 5.28.14 is the version you want to bump to.
You can also run bumpgen without arguments and select which package to upgrade from the menu. Use bumpgen --help for a complete list of options.
Github Action
We've created a GitHub action that can be used to run bumpgen. The intended usage is to be triggered on dependabot or renovatebot PRs - if breaking changes are detected, bumpgen will commit to the PR branch.
> [!NOTE]
> The action commits changes to the branch it was triggered from. If you would like those commits to trigger other CI workflows, you will need to use a GitHub Personal Access Token.
Example Workflow
> [!NOTE]
> If you'd like to be first in line to try the bumpgen GitHub App to replace your usage of dependabot + renovatebot, sign up here.
Limitations
There are some limitations you should know about.
- bumpgen relies on build errors to determine what needs to be fixed. If an issue is caused by a behavioral change, bumpgen won't detect it.
- bumpgen can't handle multiple packages at the same time. It will fail to upgrade packages that require peer dependencies to be updated the same time to work such as @octokit/core and @octokit/plugin-retry.
- bumpgen is not good with very large frameworks like vue. These kind of upgrades (and vue 2 -> 3 specifically) can be arduous even for a human.
🏙️ Architecture
Abstract Syntax Tree
The AST is generated from **ts-morph**. This AST allows bumpgen to understand the relationship between nodes in a codebase.