Publishing changesets to the code host

After you’ve created a batch change with published: false in its batch spec, you can see a preview of the changesets (e.g., GitHub pull requests) that will be created on the code host once they’re published:

In order to create these changesets on the code hosts, you need to publish them.


To publish a changeset, you need:

  1. admin permissions for the batch change,
  2. write access to the changeset’s repository (on the code host), and
  3. a personal access token configured in Sourcegraph for your code host(s).

For more information, see “Code host interactions in Batch Changes”. Forking the repository is not yet supported.

Publishing changesets

When you’re ready, you can publish all of a batch change’s changesets by changing the published: false in your batch spec to true:

name: hello-world

# ...

  # ...
  published: true

Then run the src batch preview command again, or src batch apply to immediately publish the changesets.

Publishing a changesets will:

  • Create a commit with the changes from the patches for that repository.
  • Push a branch using the branch name you defined in the batch spec with changesetTemplate.branch.
  • Create a changeset (e.g., GitHub pull request) on the code host for review and merging.

In the Sourcegraph web UI you’ll see a progress indicator for the changesets that are being published and any possible errors:

If you run into any errors, you can retry publishing after you’ve resolved the problem by running src batch apply again.

You don’t need to worry about multiple branches or pull requests being created when you retry, because the same branch name will be used and the commit will be overwritten.

Publishing a subset of changesets

Instead of publishing all changesets at the same time, you can also publish some of a batch change’s changesets, by specifying which changesets you want to publish in the published field:

# ...

  # ...
    - true
    -*: true
    -*: false

See changesetTemplate.published in the batch spec reference for more details.

Publishing changesets as drafts

Some code hosts (GitHub, GitLab) allow publishing changesets as drafts. To publish a changeset as a draft, use the 'draft’ value in the published field:

# ...

  # ...
  published: draft

See changesetTemplate.published in the batch spec reference for more details.

Fully publishing draft changesets

If you have previously published changesets as drafts on code hosts by setting published to draft, you then fully publish them and take them out of draft mode by updating the published to true.

See changesetTemplate.published in the batch spec reference for more details.

Specifying Git commit details

The commit that’s created and pushed to the branch uses the details specified in the batch spec’s changesetTemplate field.

See changesetTemplate.commit for details on how to set the author and the commit message.