Skip to content
This repository has been archived by the owner on Feb 15, 2024. It is now read-only.

Commit

Permalink
Update Go version recommendation
Browse files Browse the repository at this point in the history
- Update README
  - to direct reader to this project's go.mod file for the preferred
    Go version
  - to use reflinks vs hard-coded values
  - link to official supported Go versions documentation
- Update `go.mod` file to reflect Go 1.17
- Update Dependabot (`dependabot.yml`) configuration to ignore Go
  versions greater than or less than 1.17.x
- Update "canary" Dockerfile to reflect Go 1.17.5, the prior version
  in the 1.17.x series
  - opting to use "one version back" in order to confirm that
    Dependabot picks up the changes as intended
- Run `go mod tidy && go mod vendor`
  - updates format of go.mod to list project dependencies in separate
    direct and transitive require blocks
  - prunes go.mod, go.sum files from vendored dependencies
  - updates format of vendor/modules.txt to note specific version of
    Go used by vendored dependencies

refs GH-270
  • Loading branch information
atc0005 committed Jan 25, 2022
1 parent 935f6a5 commit 9c71fb0
Show file tree
Hide file tree
Showing 24 changed files with 58 additions and 268 deletions.
4 changes: 2 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,5 @@ updates:
versions:
# Ignore updates from series associated with the latest "stable"
# Go release and no longer supported Go versions.
- ">= 1.17"
- "< 1.16"
- ">= 1.18"
- "< 1.17"
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,8 @@ webhook requests.

## Project home

See [our GitHub repo](https://github.com/atc0005/brick) for the latest code,
to file an issue or submit improvements for review and potential inclusion
into the project.
See [our GitHub repo][repo-url] for the latest code, to file an issue or
submit improvements for review and potential inclusion into the project.

## Status

Expand Down Expand Up @@ -293,4 +292,10 @@ specific language governing permissions and limitations under the License.
Various references used when developing this project can be found in our
[references](docs/references.md) doc.

<!-- Footnotes here -->

[repo-url]: <https://github.com/atc0005/brick> "This project's GitHub repo"

[brick-logo]: media/brick-logo-rounded.png "brick project logo"

<!-- []: PLACEHOLDER "DESCRIPTION_HERE" -->
2 changes: 1 addition & 1 deletion dependabot/docker/go/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@
# binaries) to reflect that version of Go.

# https://hub.docker.com/_/golang
FROM golang:1.16.12
FROM golang:1.17.5
28 changes: 21 additions & 7 deletions docs/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,31 @@

## Requirements

The following is a loose guideline. Other combinations of Go and operating
systems for building and running tools from this repo may work, but have not
been tested.

### Building source code

- Go 1.13+
- Go
- see this project's `go.mod` file for *preferred* version
- this project tests against [officially supported Go
releases][go-supported-releases]
- the most recent stable release (aka, "stable")
- the prior, but still supported release (aka, "oldstable")
- GCC
- if building with custom options (as the provided `Makefile` does)
- `make`
- if using the provided `Makefile`

### Running

The `brick` application has been tested with:

- Go 1.13+
- Ubuntu Linux 16.04, 18.04
- Ubuntu Linux 18.04+

## Instructions

1. [Download](https://golang.org/dl/) Go
1. [Install](https://golang.org/doc/install) Go
1. [Download][go-docs-download] Go
1. [Install][go-docs-install] Go
- NOTE: Pay special attention to the remarks about `$HOME/.profile`
1. Clone the repo
1. `cd /tmp`
Expand Down Expand Up @@ -80,3 +86,11 @@ The `brick` application has been tested with:
- `/tmp/brick/release_assets/ezproxy/`
- if using separate `go build` invocations
- `/tmp/brick/`

<!-- Footnotes here -->

[go-docs-download]: <https://golang.org/dl> "Download Go"

[go-docs-install]: <https://golang.org/doc/install> "Install Go"

[go-supported-releases]: <https://go.dev/doc/devel/release#policy> "Go Release Policy"
13 changes: 12 additions & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ module github.com/atc0005/brick

// replace github.com/atc0005/go-ezproxy => ../go-ezproxy

go 1.15
go 1.17

require (
github.com/Showmax/go-fqdn v1.0.0
Expand All @@ -28,3 +28,14 @@ require (
github.com/atc0005/go-teams-notify/v2 v2.6.0
github.com/pelletier/go-toml v1.9.4
)

require (
github.com/alexflint/go-scalar v1.0.0 // indirect
github.com/fatih/color v1.7.0 // indirect
github.com/go-logfmt/logfmt v0.4.0 // indirect
github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515 // indirect
github.com/mattn/go-colorable v0.1.2 // indirect
github.com/mattn/go-isatty v0.0.8 // indirect
github.com/pkg/errors v0.8.1 // indirect
golang.org/x/sys v0.0.0-20190412213103-97732733099d // indirect
)
3 changes: 0 additions & 3 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,8 @@ github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af/go.mod h1:Nht
github.com/jpillora/backoff v0.0.0-20180909062703-3050d21c67d7/go.mod h1:2iMrUgbbvHEiQClaW2NsSzMyGHqN+rDFqY705q49KG0=
github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515 h1:T+h1c/A9Gawja4Y9mFVWj2vyii2bbUNDw3kt9VxK2EY=
github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc=
github.com/kr/pretty v0.2.0 h1:s5hAObm+yFO5uHYt5dYjxi2rXrsnmRpJx4OYvIWUaQs=
github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
github.com/mattn/go-colorable v0.1.1/go.mod h1:FuOcm+DKB9mbwrcAfNl7/TZVBZ6rcnceauSikq3lYCQ=
github.com/mattn/go-colorable v0.1.2 h1:/bC9yWikZXAL9uJdulbSfyVNIR3n3trXl+v8+1sx8mU=
Expand Down Expand Up @@ -84,7 +82,6 @@ golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=
gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw=
Expand Down
3 changes: 0 additions & 3 deletions vendor/github.com/Showmax/go-fqdn/go.mod

This file was deleted.

8 changes: 0 additions & 8 deletions vendor/github.com/alexflint/go-arg/go.mod

This file was deleted.

8 changes: 0 additions & 8 deletions vendor/github.com/alexflint/go-arg/go.sum

This file was deleted.

7 changes: 0 additions & 7 deletions vendor/github.com/alexflint/go-scalar/go.mod

This file was deleted.

6 changes: 0 additions & 6 deletions vendor/github.com/alexflint/go-scalar/go.sum

This file was deleted.

32 changes: 0 additions & 32 deletions vendor/github.com/apex/log/go.mod

This file was deleted.

117 changes: 0 additions & 117 deletions vendor/github.com/apex/log/go.sum

This file was deleted.

19 changes: 0 additions & 19 deletions vendor/github.com/atc0005/go-ezproxy/go.mod

This file was deleted.

13 changes: 0 additions & 13 deletions vendor/github.com/atc0005/go-teams-notify/v2/go.mod

This file was deleted.

Loading

0 comments on commit 9c71fb0

Please sign in to comment.