https://github.com/vincentbernat/hellogopher

Makefile to build a Go project
https://github.com/vincentbernat/hellogopher

golang makefile

Last synced: 6 days ago
JSON representation

Makefile to build a Go project

• Host: GitHub
• URL: https://github.com/vincentbernat/hellogopher
• Owner: vincentbernat
• License: cc0-1.0
• Created: 2017-01-22T16:42:26.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-10-01T08:57:36.000Z (3 months ago)
• Last Synced: 2024-10-11T14:39:51.506Z (3 months ago)
• Topics: golang, makefile
• Language: Makefile
• Size: 69.3 KB
• Stars: 309
• Watchers: 12
• Forks: 63
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• stars - vincentbernat/hellogopher
• awesome-repositories - vincentbernat/hellogopher - Makefile to build a Go project (Makefile)

README

        
# Makefile for Go projects (1.16+)

This is an example of `Makefile` to build a Go project. This is quite

similar to [Filippo Valsorda's hellogopher](https://github.com/cloudflare/hellogopher).

Initially, this is for people who don't know about `GOPATH` or who

don't want to use it (like me). However, starting with Go 1.11,

modules enable to work outside of `GOPATH` without any special

environment. This turns this `Makefile` as only a convenience tool.

This `Makefile` may not be used as is. It is expected to be modified

to fit your needs. See [Akvorado's

Makefile](https://github.com/akvorado/akvorado/blob/main/Makefile) for

an example on a more complex project.

## Dependencies

This example relies on modules to retrieve dependencies. This requires

use of Go 1.11 or more recent. To update a dependency, use `go get

DEPENDENCY@REVISION`.

We also rely on `go install TOOL@latest` which requires Go 1.16. You

can checkout tag [v0.6][] if you need compatibility up to Go 1.11.

[v0.6]: https://github.com/vincentbernat/hellogopher/tree/v0.6

Some tools now require more recent versions of Go (1.21+), but it would be

possible to pin them to older versions.

On first build, you need to run `go mod init PROJECTNAME`.

## Versioning

Version is extracted from git tags using anything prefixed by `v`.

## Usage

The following commands are available:

 - `make help` to get help

 - `make` to build the binary (in `bin/`)

 - `make test` to run tests

 - `make test-verbose` to run tests in verbose mode

 - `make test-race` for race tests

 - `make test-coverage` for test coverage (will output `coverage.html`

   and `coverage.xml` in `test/`.

 - `make test PKG=helloworld/hello` to restrict test to a package

 - `make clean`

 - `make lint` to run golint

 - `make fmt` to run gofmt

The very first line of the `Makefile` is the most important one: this

is the path of the package. I don't use a `go get`able package path

but you can.

Be sure to browse the remaining of the `Makefile` to understand what

it does. There are some tools that will be downloaded. You can use

already-installed one by specifying their full path this way instead:

    make lint GOLINT=/usr/bin/golint

Files other than `.gitignore` and `Makefile` are just examples.

## Misc

If `golint` complains with `go/build: importGo hellogopher/cmd: exit

status 2`, just delete it from `bin/` and let the Makefile build it

again.

If you prefer, you can also include this Makefile into another one.

Rename it to `hellogopher.mk` and put in `Makefile` something like

this:

    include hellogopher.mk

    

    # Your custom settings

    TIMEOUT=10

    

    # Your custom rules

    doc: ; $(info $(M) build documentation) @ ## Build documentation

    	$(MAKE) -C doc

## License

This `Makefile` is published under the CC0 1.0 license. See `LICENSE`

for more details.