Updating Go import statements using Comby
This campaign rewrites Go import paths for the
log15 package from
github.com/inconshreveable/log15 using Comby.
It can handle single-package import statements like this one:
Single-package imports with an alias:
import log15 "gopkg.in/inconshreveable/log15.v2"
And multi-package import statements with our without an alias:
import ( "io" "github.com/pkg/errors" "gopkg.in/inconshreveable/log15.v2" )
We recommend that use the latest version of Sourcegraph when working with campaigns and that you have a basic understanding of how to create campaign specs and run them. See the following documents for more information:
Create the campaign spec
Save the following campaign spec YAML as
name: update-log15-import description: This campaign updates Go import paths for the `log15` package from `gopkg.in/inconshreveable/log15.v2` to `github.com/inconshreveable/log15` using [Comby](https://comby.dev/) # Find all repositories that contain the import we want to change. on: - repositoriesMatchingQuery: lang:go gopkg.in/inconshreveable/log15.v2 # In each repository steps: # we first replace the import when it's part of a multi-package import statement - run: comby -in-place 'import (:[before]"gopkg.in/inconshreveable/log15.v2":[after])' 'import (:[before]"github.com/inconshreveable/log15":[after])' .go -matcher .go -exclude-dir .,vendor container: comby/comby # ... and when it's a single import line. - run: comby -in-place 'import:[alias]"gopkg.in/inconshreveable/log15.v2"' 'import:[alias]"github.com/inconshreveable/log15"' .go -matcher .go -exclude-dir .,vendor container: comby/comby # Describe the changeset (e.g., GitHub pull request) you want for each repository. changesetTemplate: title: Update import path for log15 package to use GitHub body: Updates Go import paths for the `log15` package from `gopkg.in/inconshreveable/log15.v2` to `github.com/inconshreveable/log15` using [Comby](https://comby.dev/) branch: campaigns/update-log15-import # Push the commit to this branch. commit: message: Fix import path for log15 package published: false
Create the campaign
In your terminal, run this command:
src campaign preview -f update-log15-import.campaign.yaml
Wait for it to run and compute the changes for each repository.
Open the preview URL that the command printed out.
Examine the preview. Confirm that the changesets are the ones you intended to track. If not, edit the campaign spec and then rerun the command above.
Click the Apply spec button to create the campaign.
Feel free to then publish the changesets (i.e. create pull requests and merge requests) by modifying the
publishedattribute in the campaign spec and re-running the
src campaign previewcommand.