s/campaign/batch change/ (#489)

* Rename command files.

* cmd/src campaigns → batch

* Minimal package renames.

* schemata changes

* non-GraphQL renames

* Rename Docker image.

* Migrate GraphQL.

* update readme

* Update canned errors in tests.

* changelog

* insert pr number here

Author: LawnGnome

.github/workflows/docker.yml

@@ -28,7 +28,7 @@ jobs:
         with:
           platforms: arm64
 
-      - run: ./docker/campaign-volume-workspace/push.py -d ./docker/campaign-volume-workspace/Dockerfile -i sourcegraph/src-campaign-volume-workspace -p linux/amd64,linux/arm64,linux/386
+      - run: ./docker/batch-change-volume-workspace/push.py -d ./docker/batch-change-volume-workspace/Dockerfile -i sourcegraph/src-batch-change-volume-workspace -p linux/amd64,linux/arm64,linux/386
         env:
           DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
           DOCKER_USERNAME: sourcegraphci
@@ -38,5 +38,5 @@ jobs:
         with:
           username: sourcegraphci
           password: ${{ secrets.DOCKER_PASSWORD }}
-          repository: sourcegraph/src-campaign-volume-workspace
-          readme-filepath: ./docker/campaign-volume-workspace/README.md
+          repository: sourcegraph/src-batch-change-volume-workspace
+          readme-filepath: ./docker/batch-change-volume-workspace/README.md

CHANGELOG.md

@@ -15,6 +15,8 @@ All notable changes to `src-cli` are documented in this file.
 
 ### Changed
 
+- Campaigns are now known as Batch Changes! The `src campaign` set of commands have been renamed to `src batch`; however, `src campaign` and `src campaigns` will be retained as aliases for `src batch` until the next major version of Sourcegraph. There should be no breaking changes as a result of this change. [#489](https://github.com/sourcegraph/src-cli/pull/489)
+
 ### Fixed
 
 ### Removed

DEVELOPMENT.md

@@ -65,16 +65,16 @@ and get the normal help output from `src`.
 
 ## Dependent Docker images
 
-`src campaign apply` and `src campaign preview` use a Docker image published as `sourcegraph/src-campaign-volume-workspace` for utility purposes when the volume workspace is selected, which is the default on macOS. This [Docker image](./docker/campaign-volume-workspace/Dockerfile) is built by [a Python script](./docker/campaign-volume-workspace/push.py) invoked by the GitHub Action workflow described in [`docker.yml`](.github/workflows/docker.yml).
+`src batch apply` and `src batch preview` use a Docker image published as `sourcegraph/src-batch-change-volume-workspace` for utility purposes when the volume workspace is selected, which is the default on macOS. This [Docker image](./docker/batch-change-volume-workspace/Dockerfile) is built by [a Python script](./docker/batch-change-volume-workspace/push.py) invoked by the GitHub Action workflow described in [`docker.yml`](.github/workflows/docker.yml).
 
 To build and develop this locally, you can build and tag the image with:
 
 ```sh
-docker build -t sourcegraph/src-campaign-volume-workspace - < docker/campaign-volume-workspace/Dockerfile
+docker build -t sourcegraph/src-batch-change-volume-workspace - < docker/batch-change-volume-workspace/Dockerfile
 ```
 
 To remove it and then force the upstream image on Docker Hub to be used again:
 
 ```sh
-docker rmi sourcegraph/src-campaign-volume-workspace
+docker rmi sourcegraph/src-batch-change-volume-workspace
 ```

README.markdown

@@ -7,7 +7,7 @@
 - **Search & get results in your terminal**
 - **Search & get JSON** for programmatic consumption
 - Make **GraphQL API requests** with auth easily & get JSON back fast
-- Execute **[campaign actions](https://docs.sourcegraph.com/user/campaigns)**
+- Execute **[batch changes](https://docs.sourcegraph.com/user/batch-changes)**
 - **Manage & administrate** repositories, users, and more
 - **Easily convert src-CLI commands to equivalent curl commands**, just add --get-curl!
 
@@ -103,9 +103,8 @@ Is your Sourcegraph instance behind a custom auth proxy? See [auth proxy configu
 
  - `src login` - authenticate to a Sourcegraph instance with your user credentials
  - `src search` - perform searches and get results in your terminal or as JSON
- - `src actions` - run [campaign actions](https://docs.sourcegraph.com/user/campaigns/actions) to generate patch sets
  - `src api` - run Sourcegraph GraphQL API requests
- - `src campaigns` - manages [campaigns](https://docs.sourcegraph.com/user/campaigns)
+ - `src batch` - execute and manage [batch changes](https://docs.sourcegraph.com/user/batch-changes)
  - `src repos` - manage repositories
  - `src users` - manage users
  - `src orgs` - manages organization

cmd/src/batch.go

@@ -0,0 +1,52 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+)
+
+var batchCommands commander
+
+func init() {
+	usage := `'src batch' manages batch changes on a Sourcegraph instance.
+
+Usage:
+
+	src batch command [command options]
+
+The commands are:
+
+	apply                 applies a batch spec to create or update a batch
+	                      change
+	new                   creates a new batch spec YAML file
+	preview               creates a batch spec to be previewed or applied
+	repos,repositories    queries the exact repositories that a batch spec will
+	                      apply to
+	validate              validates a batch spec
+
+Use "src batch [command] -h" for more information about a command.
+
+`
+
+	flagSet := flag.NewFlagSet("batch", flag.ExitOnError)
+	handler := func(args []string) error {
+		batchCommands.run(flagSet, "src batch", usage, args)
+		return nil
+	}
+
+	// Register the command.
+	commands = append(commands, &command{
+		flagSet: flagSet,
+		aliases: []string{
+			"batchchange",
+			"batch-change",
+			"batchchanges",
+			"batch-changes",
+			"batches",
+			"campaign",
+			"campaigns",
+		},
+		handler:   handler,
+		usageFunc: func() { fmt.Println(usage) },
+	})
+}

cmd/src/campaigns_apply.go renamed to cmd/src/batch_apply.go

@@ -6,49 +6,49 @@ import (
 	"flag"
 	"fmt"
 
-	"github.com/sourcegraph/src-cli/internal/campaigns"
+	"github.com/sourcegraph/src-cli/internal/batches"
 	"github.com/sourcegraph/src-cli/internal/output"
 )
 
 func init() {
 	usage := `
-'src campaigns apply' is used to apply a campaign spec on a Sourcegraph
-instance, creating or updating the described campaign if necessary.
+'src batch apply' is used to apply a batch spec on a Sourcegraph instance,
+creating or updating the described batch change if necessary.
 
 Usage:
 
-    src campaigns apply -f FILE [command options]
+    src batch apply -f FILE [command options]
 
 Examples:
 
-    $ src campaigns apply -f campaign.spec.yaml
+    $ src batch apply -f batch.spec.yaml
   
-    $ src campaigns apply -f campaign.spec.yaml -namespace myorg
+    $ src batch apply -f batch.spec.yaml -namespace myorg
 
 `
 
 	flagSet := flag.NewFlagSet("apply", flag.ExitOnError)
-	flags := newCampaignsApplyFlags(flagSet, campaignsDefaultCacheDir(), campaignsDefaultTempDirPrefix())
+	flags := newBatchApplyFlags(flagSet, batchDefaultCacheDir(), batchDefaultTempDirPrefix())
 
-	doApply := func(ctx context.Context, out *output.Output, svc *campaigns.Service, flags *campaignsApplyFlags) error {
-		id, _, err := campaignsExecute(ctx, out, svc, flags)
+	doApply := func(ctx context.Context, out *output.Output, svc *batches.Service, flags *batchApplyFlags) error {
+		id, _, err := batchExecute(ctx, out, svc, flags)
 		if err != nil {
 			return err
 		}
 
-		pending := campaignsCreatePending(out, "Applying campaign spec")
-		campaign, err := svc.ApplyCampaign(ctx, id)
+		pending := batchCreatePending(out, "Applying batch spec")
+		batch, err := svc.ApplyBatchChange(ctx, id)
 		if err != nil {
 			return err
 		}
-		campaignsCompletePending(pending, "Applying campaign spec")
+		batchCompletePending(pending, "Applying batch spec")
 
 		out.Write("")
-		block := out.Block(output.Line(campaignsSuccessEmoji, campaignsSuccessColor, "Campaign applied!"))
+		block := out.Block(output.Line(batchSuccessEmoji, batchSuccessColor, "Batch change applied!"))
 		defer block.Close()
 
-		block.Write("To view the campaign, go to:")
-		block.Writef("%s%s", cfg.Endpoint, campaign.URL)
+		block.Write("To view the batch change, go to:")
+		block.Writef("%s%s", cfg.Endpoint, batch.URL)
 
 		return nil
 	}
@@ -67,7 +67,7 @@ Examples:
 		ctx, cancel := contextCancelOnInterrupt(context.Background())
 		defer cancel()
 
-		svc := campaigns.NewService(&campaigns.ServiceOpts{
+		svc := batches.NewService(&batches.ServiceOpts{
 			AllowUnsupported: flags.allowUnsupported,
 			Client:           cfg.apiClient(flags.api, flagSet.Output()),
 			Workspace:        flags.workspace,
@@ -86,11 +86,11 @@ Examples:
 		return nil
 	}
 
-	campaignsCommands = append(campaignsCommands, &command{
+	batchCommands = append(batchCommands, &command{
 		flagSet: flagSet,
 		handler: handler,
 		usageFunc: func() {
-			fmt.Fprintf(flag.CommandLine.Output(), "Usage of 'src campaigns %s':\n", flagSet.Name())
+			fmt.Fprintf(flag.CommandLine.Output(), "Usage of 'src batch %s':\n", flagSet.Name())
 			flagSet.PrintDefaults()
 			fmt.Println(usage)
 		},