groundcontrol

README

Ground Control (WIP)

Ground Control is an application to help deal with multi-repository development using a user friendly web interface.

You define workspaces in a YAML file. A workspace contains multiple projects. A project corresponds to a branch of a repository.

The Ground Control user interface allows you to perform operations across the projects of a workspace, including:

• Clone all repositories (defaults to $HOME/groundcontrol/workspaces/WORKSPACE/PROJECT)
• Check the status of repositories against their origins
• Pull all outdated repositories
• Define workspace wide tasks
• Create scripts to launch multi-repository applications

Installation

macOS (homebrew)

Simply run:

brew install stratumn/groundcontrol/groundcontrol

Once installed, you can update to latest version by running:

brew upgrade groundcontrol

Prebuilt binaries

Head over to the latest release and download the binary for your platform.

From source

You need:

• Go >= v1.11
• Node
• Yarn

Clone outside of $GOPATH since it's a Go module.

Run:

make # <---- builds `./groundcontrol`
make install # <---- copies it to `$GOPATH/bin`

Usage

After installing, run:

ssh-add # <---- to use your SSH key for accessing private repos
groundcontrol

Development

If you didn't run make, do:

make deps
make gen-go

Server

go run .

Server runs on http://localhost:3333.

UI

cd ui
yarn dev

UI runs on http://localhost:3000 during development.

Releasing

brew install goreleaser/tap/goreleaser
git tag -a vX.X.X -m "New release"
git push origin vX.X.X
goreleaser

Notes

General

• Lines of code don't matter if the code can be generated. Focus on writing repeatable code then write a generator once it makes sense.

Server

• GraphQL models should be pure. Mutations should create a new copy of the model. Avoid pointer accessors for models.
• Reference GraphQL models by ID. Do not keep pointers. Do not pass models around.
• Models should only store GraphQL fields and IDs of nodes they reference. They must not store a mutex. Use NodeManager.Lock().
• Queries must have no side effects (except appending the log). This may require more mutations triggered by the client.

Client

• Queries, mutations, subscriptions, and events must be handled at the top level.
• Avoid using @relay(mask: false).

Documentation

Overview

The entry point for the Ground Control application.