Skip to content

Commit

Permalink
Remove the makefile and all references to it in CONTRIBUTING.md and R…
Browse files Browse the repository at this point in the history
…EADME.md
  • Loading branch information
rafibarash committed Sep 1, 2021
1 parent aeb1acb commit 6d3c3e1
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 80 deletions.
16 changes: 6 additions & 10 deletions CONTRIBUTING.md
Expand Up @@ -23,7 +23,8 @@ Before you submit your pull request consider the following guidelines:
* Run the full test suite.

```shell
make test
go build
go test -timeout 10s -v ./...
```
* Commit your changes using a descriptive commit message.

Expand All @@ -32,12 +33,6 @@ Before you submit your pull request consider the following guidelines:
```
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.

* Build your changes locally to ensure all the tests pass:

```shell
make test
```

* Push your branch to GitHub:

```shell
Expand Down Expand Up @@ -96,10 +91,11 @@ After your pull request is merged, you can safely delete your branch and pull th
* Source files must be formatted with `gofmt` and updated with `go fix` before submission.

```shell
make pretty
go fmt
go fix
```
* Source files should be inspected by `go vet` and `golint`. Since there may be false positives with both, ignored warnings require justification but won't necessarily block changes.
* Source files should be inspected by `go vet`. Since there may be false positives with both, ignored warnings require justification but won't necessarily block changes.

```shell
make criticism
go vet
```
66 changes: 0 additions & 66 deletions Makefile

This file was deleted.

8 changes: 4 additions & 4 deletions README.md
Expand Up @@ -52,7 +52,7 @@ As of the 2.0 release, `docker-credential-gcr` no longer supports generalized [`

### Building from Source

The program in this repository is written with the Go programming language and built with `make`. These instructions assume that [**Go 1.11+**](https://golang.org/) and `make` are installed on a \*nix system.
The program in this repository is written with the Go programming language and can be built with `go build`. These instructions assume you are using [**Go 1.13+**](https://golang.org/) or higher.

You can download the source code, compile the binary, and put it in your `$GOPATH` with `go get`.

Expand All @@ -62,17 +62,17 @@ go get -u github.com/GoogleCloudPlatform/docker-credential-gcr

If `$GOPATH/bin` is in your system `$PATH`, this will also automatically install the compiled binary. You can confirm using `which docker-credential-gcr` and continue to the [section on Configuration and Usage](#configuration-and-usage).

Alternatively, you can use `make` to build the program. The executable will be output to the `bin` directory inside the repository.
Alternatively, you can use `go build` to build the program. This creates a `docker-credential-gcr` executable.

```shell
cd $GOPATH/src/github.com/GoogleCloudPlatform/docker-credential-gcr
make
go build
```

Then, you can put that binary in your `$PATH` to make it visible to `docker`. For example, if `/usr/bin` is present in your system path:

```shell
sudo mv ./bin/docker-credential-gcr /usr/bin/docker-credential-gcr
sudo mv ./docker-credential-gcr /usr/bin/docker-credential-gcr
```

## Configuration and Usage
Expand Down

0 comments on commit 6d3c3e1

Please sign in to comment.