Creating deployments
Create a deployment in Hypermod to combine codemods and static actions into a workflow, target repositories, and open pull requests.
A deployment is how you take one or more codemods and apply them to real repositories. In Hypermod, a deployment can include both codemods and static actions such as file moves, dependency changes, and file creation.
Together, the ordered list of codemods and actions in a deployment is called a workflow.
If you have not created a codemod yet, start with Creating a Codemod.
Before you begin
Before creating a deployment, make sure that:
- You are signed in to Hypermod.
- Your target repositories are connected. See Installation.
- You already have at least one codemod in your Library, or you know which community codemods you want to use.
How to create a deployment
1. Open the Deployments page
Navigate to Deployments from your dashboard. This page shows the status of current and previous deployments created by you and your team.
2. Click New deployment
In the top-right corner, click New deployment to open the deployment builder.
3. Enter a clear title and description
Start by adding a descriptive title and description for the change.
Hypermod uses these values as the pull request title and pull request description in GitHub, so write them for reviewers, not just for yourself. A good description should explain what is changing, why it matters, and anything reviewers should pay attention to.
4. Build your workflow
Next, choose the codemods and static actions that should be included in the deployment.
Codemods
Codemods are reusable programmatic transforms that inspect and rewrite code. Use them when you need to update source files intelligently, such as renaming APIs, changing imports, or migrating framework usage.
You can choose codemods from:
- Your private codemods in the Library
- Community codemods published by others
Static actions
Static actions are predefined file and dependency operations. They are useful for changes that do not need AST-based code transformation, such as:
- installing, removing, or upgrading dependencies
- creating or deleting files
- moving or renaming files and folders
Use static actions when the change is mechanical and does not require a custom codemod.
5. Put items in the right order
The selected codemods and actions run in the order shown in the workflow. You can drag and drop items to reorder them.
This matters because later steps often depend on earlier ones. For example, you might upgrade a dependency first, then run a codemod that updates the code to match the new API.
6. Select the target repositories
After building your workflow, choose which connected repositories should receive the deployment.
If you manage many repositories, take a moment to confirm you are targeting the right set before continuing.
7. Review and deploy
Review your title, description, workflow order, and selected repositories. When everything looks correct, click Deploy.
Hypermod will create the deployment and begin opening pull requests for the selected repositories.
What to expect after clicking Deploy
Deployments are not always instant. Depending on the number of repositories and the amount of work in the workflow, it may take a few minutes to complete.
Once the deployment finishes, you will be able to see the newly opened pull requests from the deployment details page.
Tips for better deployments
- Use descriptive PR titles so teams can understand the change at a glance.
- Keep workflow steps ordered intentionally.
- Start with a smaller set of repositories if you are testing a new codemod.
- Combine codemods and static actions when a migration needs both code changes and repository-level updates.