From d427d4917f626a9e28760467a19f0aca9a1e212c Mon Sep 17 00:00:00 2001 From: Richard North Date: Mon, 14 Nov 2022 10:40:57 +0000 Subject: [PATCH] Add brew release instructions to README, and fix brew formula linting issues (#86) --- .goreleaser.yml | 4 ++-- README.md | 21 +++++++++++++++++++-- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/.goreleaser.yml b/.goreleaser.yml index 91e392a..c03bcee 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -23,9 +23,9 @@ checksum: name_template: 'checksums.txt' brews: - name: turbolift - description: A simple tool to help apply changes across many GitHub repositories simultaneously + description: Simple tool to help apply changes across many GitHub repositories simultaneously homepage: https://github.com/Skyscanner/turbolift - license: Apache 2.0 + license: Apache-2.0 tap: owner: Skyscanner name: homebrew-tools diff --git a/README.md b/README.md index 7cf0146..e8db3b2 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ It's dumb but it works. It doesn't scale well, though. Manually cloning and rais Turbolift essentially automates the boring parts and stays out of the way when it comes to actually making the changes. It automates cloning, committing, and raising PRs en-masse, so that you can focus on the substance of the change. > Historical note: Turbolift supersedes an internal system at Skyscanner named Codelift. Codelift was a centralised batch system, requiring changes to be scripted upfront and run overnight. While Codelift was useful, we have found that a decentralised, interactive tool is far easier and quicker for people to use in practice. +> +> [This blog post](https://medium.com/@SkyscannerEng/turbolift-a-tool-for-refactoring-at-scale-70603314f7cc) gives a longer background for the thinking behind Turbolift. ## Demo @@ -20,7 +22,20 @@ This demo shows Turbolift in action, creating a simple PR in two repositories: ## Installation -### Downloading binaries +
+Using brew (recommended) +Install turbolift using brew from Skyscanner's tap, as follows: + +```shell +brew install skyscanner/tools/turbolift +``` + +Note that the GitHub CLI, `gh` is a dependency of Turbolift and will be installed automatically. + +
+ +
+Downloading binaries Pre-built binary archives can be downloaded from the [Releases](https://github.com/Skyscanner/turbolift/releases) page. @@ -30,7 +45,9 @@ Pre-built binary archives can be downloaded from the [Releases](https://github.c 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. +
+ +> 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: