Skip to main content

Branches

A Branch in Artemis is a bundle of proposed code changes that you review, verify and publish. It lives in Artemis until you publish it, so your Git provider is untouched until then. The API and CLI call it a changeset.

An Artemis Branch is different from a branch on your Git provider and from a Pull Request. Publishing pushes it to your provider as a Git branch, and you can then open a Pull Request from it.

Open Branches in the Project sidebar to see them all.

Where Branches come from​

  • Describe a change in the composer at the top of the Branches page, or start from a suggestion such as Fix a bug or Add Unit Tests for Coverage Gaps. A coding agent makes the change on a new Branch.
  • New Branch creates an empty Branch you can work on later.
  • Build plan on a Plan builds its Tasks on a new Branch.
  • Fix on a Maintain Issue puts the fix on a Branch.
  • Create PR on a Discovery Version opens that Version's Branch.

Search the list by name and filter it by status: All, Unpublished or Published.

Inside a Branch​

A Branch has four tabs:

  • Files shows the code as it is on the Branch.
  • Changes shows the diff against the base. Select a range of commits to review them step by step, switch between split and unified layout, and mark files as viewed.
  • Scripts runs a Script against the Branch on a Runner and keeps every run.
  • Compare plots a metric for this Branch against other Branches that recorded it.

The chat panel on the right works on the Branch. Ask it to Explain changes, Fix failing validation or Suggest improvements, or describe a further change. Its edits are committed to the Branch automatically.

Verify a Branch​

On the Scripts tab, click Run script, choose the Script and the Runner, and run it. The Script's commands run on that Runner against the Branch's saved code, and the run records each command's status and logs plus any metrics your benchmark writes to artemis_results.json. See Metrics for how custom metrics are produced.

Every run is kept in Script runs, so you can compare it with earlier runs or Run again after a fix. If you have not set up a Runner or a Script yet, see Runner and Scripts.

A passing Validation shows only what its commands checked. To go further with a measured Branch, Optimise in Discover starts a Discovery Run from it.

Publish and open a Pull Request​

  • Publish pushes the Branch to your Git provider. After more changes, Push changes updates the published branch.
  • Create PR opens the Pull Request form: the branch name, the base branch you are merging into, a title and a description. Generate with AI drafts the title and description from the diff.

If the published branch has moved on, Resolve conflicts helps you bring the two back together. From the Branch's actions you can also Download as ZIP, Download git patch or Delete branch. Deleting a Branch in Artemis leaves any published branch on your Git remote.

Last updated on by Eoin