Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.4 KB
Raw

Contributing Guide

This is part of the Porter project. If you are a new contributor, check out our New Contributor Guide. The Porter Contributing Guide also has lots of information about how to interact with the project.

Initial setup

You need to have porter installed first. Then run mage build install. This will build and install the plugin into your porter home directory.

Magefile explained

We use mage instead of make. If you don't have mage installed already, you can install it with go run mage.go EnsureMage.

Mage targets are not case-sensitive, but in our docs we use camel case to make it easier to read. You can run either mage Build or mage build for example.

Run mage without any arguments to see a list of the available targets. Below are some commonly used targets:

  • Build builds the plugin.
  • Install installs the plugin into ~/.porter/plugins.
  • TestUnit runs the unit tests.

Debugging

To debug the plugin, follow the instructions in the porter plugin debugging guide.