Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 1.27 KB

BUILD.md

File metadata and controls

53 lines (35 loc) · 1.27 KB
Raw

AWS Simple EC2 CLI: Build Instructions

Install Go version 1.18+

There are several options for installing go:

  1. If you're on mac, you can simply brew install go
  2. If you'd like a flexible go installation manager consider using gvm https://github.com/moovweb/gvm
  3. For all other situations use the official go getting started guide: https://golang.org/doc/install

Build

This project uses make to organize compilation, build, and test targets.

To build cmd/main.go, which will build the full static binary and pull in depedent packages, run:

$ make build

The resulting binary will be in the generated build/ dir

$ make build

$ ls build/
simple-ec2

Test

You can execute the unit tests for the instance selector with make:

$ make unit-test

Run All Tests

The full suite includes unit tests, end-to-end tests, license-test, and more. See the full list in the makefile. NOTE: some tests require AWS Credentials to be configured on the system:

$ make test

Format

To keep our code readable with go conventions, we use goimports to format the source code. Make sure to run goimports before you submit a PR or you'll be caught by our tests!

You can use the make fmt target as a convenience

$ make fmt