Skip to content

have you backported your PRs today?

Notifications You must be signed in to change notification settings

cockroachdb/backboard

Repository files navigation

Backboard is a web-based tool for managing back ports of changes to maintenance branches.

Dashboard: https://backboard.crdb.dev/

GitHub repo: https://github.com/cockroachdb/backboard

Deployment

  1. Before deploying, make sure you set the credentials by running the following command:
gcloud container clusters get-credentials prime --region us-east4 --project cockroach-dev-inf
  1. Make sure --branch is set to the latest release branch in git in k8s/backboard.yaml.

  2. If you need to apply changes made to the kubernetes manifest, run kubectl -f k8s/backboard.yaml.

  3. If the app is changed or you need to update the docker image, run ./push.sh

Local development

  1. Setup a local CockroachDB server:
    cockroach start-single-node --insecure --advertise-addr=0.0.0.0
    # in a separate shell
    cockroach sql --insecure -e "CREATE DATABASE backboard"
  2. Create a GitHub token using your personal account. The token doesn't need any special permissions.
  3. Build backboard: go build -o backboard
  4. Run backboard without the --bind argument. It will run the initial synchronization.
    BACKBOARD_GITHUB_TOKEN=$token \
      ./backboard \
        --conn="postgresql://root@127.0.0.1:26257/backboard?sslmode=disable" \
        --branch=release-23.1
  5. It will take quite a while for the first bootstrap to happen.
  6. Run backboard
    BACKBOARD_GITHUB_TOKEN=$token \
      ./backboard --bind=0.0.0.0:3333 \
        --conn="postgresql://root@127.0.0.1:26257/backboard?sslmode=disable" \
        --branch=release-23.1
  7. Open http://localhost:3333 in browser.