Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 2.7 KB

local-development.md

File metadata and controls

86 lines (59 loc) · 2.7 KB

Getting Started with Development

These instructions will get you a copy of the project up and running on your local machine for development, testing, and contribution purposes.

Please read the CLI Style Guide before implementing any features or modifying behavior as it contains expectations surrounding how the CLI should behave.

All changes to behavior must be documented in the CHANGELOG.md.

Prerequisites

To get started with local development, you will need three things:

  • Golang installed locally (instructions available here).
  • A version of make available for usage of the Makefile.
  • The repository checked out in the appropriate location of your $GOPATH.

Ensure you've checked out the repository into the appropriate path inside your $GOPATH. For example, if your $GOPATH is set to ~/go, then you'd check this repository out at ~/go/src/github.com/smallstep/cli. You can learn more about $GOPATH in the documentation.

Installing Dependencies and Bootstrapping

Once you've cloned the repository to the appropriate location, you will now be able to install any other dependencies via the make bootstrap command.

You should only ever need to run this command once, as it will ensure you have the right version of golangci-lint installed.

Building step

To build step, simply run make build which will build the cli and place the binary in the bin folder.

Running Tests and Linting

Now that you've installed any dependencies, you can run the tests and lint the code base simply by running make.

Unit Tests

Run the unit tests:

make test

Integration Tests

Run the integration tests:

make integration

And coding style tests

These tests apply the following Go linters to verify code style and formatting:

make lint

Adding and Removing Dependencies

To add any dependency to the repository, simply import it into your code and then run go get <pkg> which will update the go.mod and go.sum file. A specific version of a dependency can be specified by adding it to the go.mod file.

To remove a dependency, simply remove it from the codebase and any mention of it in the go.mod file and run go mod tidy which will remove it from the the go.sum file.