Managing agent versions

Managing agent versions is crucial for maintaining control over your deployed agents. Versioning agents and actions ensures that you can track changes, roll back to previous versions if necessary, and update agents with confidence.

Whether you're updating agents or actions for performance improvements, security patches, or new features, version control provides the flexibility and reliability needed in an enterprise environment.

Agent versioning helps you roll out new agent versions without disrupting ongoing workflows of your colleagues using the agents. This ensures that production environment remains stable while testing or deploying updates.

Versions within an agent
Versions within an agent

Best practice for version numbers

How to number agent versions? We recommend you use semantic versioning (opens in a new tab). In short, that means, for example, 2.5.3.

When you publish a new version of an agent, you can't overwrite an existing agent by using the same version number. A version of a new agent version published to Control Room must always be higher than the version existing in Control Room.

Studio automatically enforces version increment when you publish an agent to Control Room. You can also increment the version manually in the agent-spec.yaml agent configuration file.

How to work with agent versions

Discover how to leverage agent versioning in Control Room to maintain development flexibility while in control over your agents across environments.

Publish a new version

When you update an agent in Studio or VS Code, you can publish the new version directly to Control Room. This keeps the previous version intact without affecting current deployments, until you green-light it yourself.

You're in control over what's deployed

When you publish a new agent version to Control Room Gallery, none of the deployments to Work Room are automatically updated.

Update an agent

Once you publish a new version of an agent to Control Room, you can update your deployments one-by-one to the new version to make it available to your colleagues in Work Room.

Roll back to a previous version

If the new version of an agent isn't performing as expected, you can select a previous version and deploy it to Work Room instead of the newer one.

Once you optimize the agent and publish another newer version to Control Room, you can deploy over the previous version.

Track versions

Control Room keeps a log of all versions, making it easy to track changes and ensure that the correct version is deployed across different environments. This is especially useful in environments where multiple teams are managing agents.