Quickstart for Campaigns

Get started and create your first Sourcegraph campaign in 10 minutes or less.

Introduction

In this guide, you’ll create a Sourcegraph campaign that appends text to all README.md files in all of your repositories.

The only requirement is a Sourcegraph instance with a some repositories in it. See the “Quickstart” guide on how to setup a Sourcegraph instance.

For more information about campaigns see the “Campaigns” documentation and watch the campaigns demo video.

Configure code host connections

Campaigns need write permissions for the repositories in which you want to make changes.

Configure your code host connections to have the right permissions for campaigns:

See “Code host interactions in campaigns” for details on what the permissions are used for.

Install the Sourcegraph CLI

In order to create campaigns we need to install the Sourcegraph CLI (src).

  1. Install the version of src that’s compatible with your Sourcegraph instance:

    macOS:

    curl -L https://YOUR-SOURCEGRAPH-INSTANCE/.api/src-cli/src_darwin_amd64 -o /usr/local/bin/src
    chmod +x /usr/local/bin/src
    

    Linux:

    curl -L https://YOUR-SOURCEGRAPH-INSTANCE/.api/src-cli/src_linux_amd64 -o /usr/local/bin/src
    chmod +x /usr/local/bin/src
    

    Windows: see “Sourcegraph CLI for Windows”

  2. Authenticate src with your Sourcegraph instance by running src login and following the instructions:

    src login https://YOUR-SOURCEGRAPH-INSTANCE
    

Once src login reports that you’re authenticated, we’re ready for the next step.

Write a campaign spec

A campaign spec is a YAML file that defines a campaign. It specifies which changes should be made in which repositories and how those should be published on the code host.

See the “Campaign spec YAML reference” for details.

Save the following campaign spec as hello-world.campaign.yaml:

name: hello-world
description: Add Hello World to READMEs

# Find all repositories that contain a README.md file.
on:
  - repositoriesMatchingQuery: file:README.md

# In each repository, run this command. Each repository's resulting diff is captured.
steps:
  - run: echo Hello World | tee -a $(find -name README.md)
    container: alpine:3

# Describe the changeset (e.g., GitHub pull request) you want for each repository.
changesetTemplate:
  title: Hello World
  body: My first campaign!
  branch: hello-world # Push the commit to this branch.
  commit:
    message: Append Hello World to all README.md files
  published: false

Create the campaign

Let’s see the changes that will be made. Don’t worry—no commits, branches, or changesets will be published yet (the repositories on your code host will be untouched).

  1. In your terminal, run this command:

    src campaign preview -f hello-world.campaign.yaml -namespace USERNAME_OR_ORG

    The namespace is either your Sourcegraph username or the name of a Sourcegraph organisation under which you want to create the campaign. If you’re not sure what to choose, use your username.

  2. Wait for it to run and compute the changes for each repository.

  3. When it’s done, click the displayed link to see all of the changes that will be made.

  4. Make sure the changes look right.

  5. If you want to modify which changes are made, edit the hello-world.campaign.yaml file, rerun the src campaign preview command and open the newly generated preview URL.

  6. Click the Apply spec button to create the campaign. You should see something like this:

You created your first campaign! The campaign’s changesets are still unpublished, which means they exist only on Sourcegraph and haven’t been pushed to your code host yet.

Publish the changes

So far, nothing has been created on the code hosts yet. For that to happen, we need to publish the changesets in our campaign.

Publishing causes commits, branches, and pull requests/merge requests to be created on your code host.

You probably don’t want to publish these toy “Hello World” changesets to actively developed repositories, because that might confuse people (“Why did you add this line to our READMEs?”).

On a real campaign, you would do the following:

  1. Change the published: false in hello-world.campaign.yaml to published: true.

  2. Run the src campaign preview command again and open the URL.

  3. On the preview page you can confirm that changesets will be published when the spec is applied.

  4. Click the Apply spec button and those changesets will be published on the code host.

Congratulations!

You’ve created your first campaign! 🎉🎉

You can customize your campaign spec and experiment with making other types of changes.

To update your campaign, edit hello-world.campaign.yaml and run src campaign preview again. (As before, you’ll see a preview before any changes are applied.)

To learn what else you can do with campaigns, see “Campaigns” in Sourcegraph documentation.