Skip to content

Commit

Permalink
Update installation instructions for binary download (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
rnorth committed Apr 30, 2021
1 parent 80c664a commit 775dfc6
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,17 @@ This demo shows Turbolift in action, creating a simple PR in two repositories:

## Installation

TODO: needs to be actually made usable
### Downloading binaries

Git clone and place scripts on the `PATH`.
Pre-built binary archives can be downloaded from the [Releases](https://github.com/Skyscanner/turbolift/releases) page.

You must have the GitHub CLI, `gh`, installed (use brew to install).
* Download, extract the archive, and move it onto your `PATH`.
* Note that the binaries are not currently notarized for MacOS Gatekeeper. If errors are displayed, use `spctl --add PATH_TO_TURBOLIFT_BINARY`.

Before using Turbolift, run `gh auth login` once and follow the prompts.
You must also have the GitHub CLI, `gh`, installed:

* Install using `brew install gh`
* Before using Turbolift, run `gh auth login` once and follow the prompts, to authenticate against github.com and/or your GitHub Enterprise server.

## Basic usage:

Expand Down Expand Up @@ -56,6 +60,12 @@ With great power comes great responsibility. We encourage Turbolift users to con

### `init` - getting set up

As per the installation instructions above, make sure `gh` is installed and authenticated before starting.

If working with repositories on a GitHub Enterprise server, ensure that you have the environment variable `GH_HOST` set to point to that server.

To begin working with Turbolift and create a 'campaign' to hold settings and working copies of repositories:

```turbolift init --name CAMPAIGN_NAME```

This creates a new turbolift 'campaign' directory ready for you to work in.
Expand All @@ -65,8 +75,6 @@ Next, please run:

```cd CAMPAIGN_NAME```

Ensure that the `GH_TOKEN` and `GH_HOST` environment variables are already set in your shell.

## Identifying the repos to operate upon

Update repos.txt with the names of the repos that need changing (either manually or using a tool to identify the repos).
Expand Down

0 comments on commit 775dfc6

Please sign in to comment.