From f2c26bab772e6b69a9fca945534728678578eb2b Mon Sep 17 00:00:00 2001 From: russoj88 Date: Tue, 13 Aug 2019 21:10:38 -0700 Subject: [PATCH 1/7] Rewrite the "pinning to v1" section. --- README.md | 19 +++---------------- 1 file changed, 3 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 29ed171..6748476 100644 --- a/README.md +++ b/README.md @@ -108,25 +108,12 @@ import ( ... ``` -### Pinning to the `v1` releases +### Using `v1` releases -Similarly to the section above describing use of the `v2` branch, if one wants -to avoid any unexpected compatibility pains once `v2` becomes `master`, then -pinning to `v1` is an acceptable option, e.g.: +Use the github URL to use the v1 branch. This is illustrated in the Getting Started section below. -``` -$ go get gopkg.in/urfave/cli.v1 -``` - -``` go -... -import ( - "gopkg.in/urfave/cli.v1" // imports as package "cli" -) -... -``` +Do not use the gopkg.in URL as it does not work for versions >= 1.21.0. -This will pull the latest tagged `v1` release (e.g. `v1.18.1` at the time of writing). ## Getting Started From f529dad70caa6e307f95eecb2db6f16efc0f964d Mon Sep 17 00:00:00 2001 From: russoj88 Date: Wed, 14 Aug 2019 11:20:58 -0700 Subject: [PATCH 2/7] Update README.md Include suggestion to put example in. Co-Authored-By: Lynn Cyrin (they/them) --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6748476..9ecef10 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,13 @@ import ( ### Using `v1` releases -Use the github URL to use the v1 branch. This is illustrated in the Getting Started section below. +$ go get github.com/urfave/cli + +package main + +import ( + "github.com/urfave/cli" +) Do not use the gopkg.in URL as it does not work for versions >= 1.21.0. From cc091db561b137c49cbf370766a94b47cfdae182 Mon Sep 17 00:00:00 2001 From: russoj88 Date: Wed, 14 Aug 2019 11:21:40 -0700 Subject: [PATCH 3/7] Update README.md Only instruct on right way to use library. Co-Authored-By: Lynn Cyrin (they/them) --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 9ecef10..f611bfa 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,6 @@ import ( "github.com/urfave/cli" ) -Do not use the gopkg.in URL as it does not work for versions >= 1.21.0. ## Getting Started From 62b8a7cc2cb05b1a454908087b35e5780a1d12ad Mon Sep 17 00:00:00 2001 From: russoj88 Date: Wed, 14 Aug 2019 11:20:09 -0700 Subject: [PATCH 4/7] Add "Using v1 releases" to table of contents. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f611bfa..224224c 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ applications in an expressive way. - [Installation](#installation) * [Supported platforms](#supported-platforms) * [Using the `v2` branch](#using-the-v2-branch) - * [Pinning to the `v1` releases](#pinning-to-the-v1-releases) + * [Using `v1` releases](#using-v1-releases) - [Getting Started](#getting-started) - [Examples](#examples) * [Arguments](#arguments) From 3bc62c4fde03e107cad02f8828780470258b8fc0 Mon Sep 17 00:00:00 2001 From: russoj88 Date: Thu, 15 Aug 2019 12:30:29 -0700 Subject: [PATCH 5/7] Mimic v2 example code from above. --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 224224c..cbb0b37 100644 --- a/README.md +++ b/README.md @@ -110,14 +110,17 @@ import ( ### Using `v1` releases +``` $ go get github.com/urfave/cli +``` -package main - +```go +... import ( "github.com/urfave/cli" ) - +... +``` ## Getting Started From e11183fe50e3b3d75e481b1262e3222c565ba8bf Mon Sep 17 00:00:00 2001 From: "Lynn Cyrin (they/them)" Date: Sat, 17 Aug 2019 02:44:49 -0700 Subject: [PATCH 6/7] Modernize readme I assume that people no longer care about what the package was named many years ago --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 29ed171..70137ec 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,6 @@ cli [![Go Report Card](https://goreportcard.com/badge/urfave/cli)](https://goreportcard.com/report/urfave/cli) [![codecov](https://codecov.io/gh/urfave/cli/branch/master/graph/badge.svg)](https://codecov.io/gh/urfave/cli) -This is the library formerly known as `github.com/codegangsta/cli` -- Github -will automatically redirect requests to this repository, but we recommend -updating your references for clarity. - cli is a simple, fast, and fun package for building command line apps in Go. The goal is to enable developers to write fast and distributable command line applications in an expressive way. From 487c7236736db7d5d2e46633d09453d0e149a0bd Mon Sep 17 00:00:00 2001 From: Sascha Grunert Date: Fri, 23 Aug 2019 10:28:32 +0200 Subject: [PATCH 7/7] Cleanup go modules These two dependencies are not really needed, which can be reproduced via: ``` > export GO111MODULE=on && go mod tidy ``` Signed-off-by: Sascha Grunert --- go.mod | 2 -- go.sum | 4 ---- 2 files changed, 6 deletions(-) diff --git a/go.mod b/go.mod index 91106bc..1b94cfe 100644 --- a/go.mod +++ b/go.mod @@ -5,7 +5,5 @@ go 1.10 require ( github.com/BurntSushi/toml v0.3.1 github.com/cpuguy83/go-md2man v1.0.10 - github.com/shurcooL/httpfs v0.0.0-20190707220628-8d4bc4ba7749 // indirect - github.com/shurcooL/vfsgen v0.0.0-20181202132449-6a9ea43bcacd // indirect gopkg.in/yaml.v2 v2.2.2 ) diff --git a/go.sum b/go.sum index 2b8b863..a8e436a 100644 --- a/go.sum +++ b/go.sum @@ -4,10 +4,6 @@ github.com/cpuguy83/go-md2man v1.0.10 h1:BSKMNlYxDvnunlTymqtgONjNnaRV1sTpcovwwjF github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE= github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo= github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g= -github.com/shurcooL/httpfs v0.0.0-20190707220628-8d4bc4ba7749 h1:bUGsEnyNbVPw06Bs80sCeARAlK8lhwqGyi6UT8ymuGk= -github.com/shurcooL/httpfs v0.0.0-20190707220628-8d4bc4ba7749/go.mod h1:ZY1cvUeJuFPAdZ/B6v7RHavJWZn2YPVFQ1OSXhCGOkg= -github.com/shurcooL/vfsgen v0.0.0-20181202132449-6a9ea43bcacd h1:ug7PpSOB5RBPK1Kg6qskGBoP3Vnj/aNYFTznWvlkGo0= -github.com/shurcooL/vfsgen v0.0.0-20181202132449-6a9ea43bcacd/go.mod h1:TrYk7fJVaAttu97ZZKrO9UbRa8izdowaMIZcxYMbVaw= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=