Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (37 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 1.19 KB

Contributing to helm s3 plugin

Prerequisites

You need to have task utility to run development tasks.

Development

First of all, clone the repository to your machine.

$ git clone https://github.com/hypnoglow/helm-s3.git
$ cd helm-s3

After that you need to install the plugin from the filesystem.

On regular plugin installation, helm triggers post-install hook that downloads prebuilt versioned release of the plugin binary and installs it. To disable this behavior, you need to pass HELM_S3_PLUGIN_NO_INSTALL_HOOK=true to the installer. task does this automatically:

$ task install
Development mode: not downloading versioned release.
Installed plugin: s3

This will first download all dependencies, then build the plugin and install it to the local helm plugin directory.

If you see no errors - build was successful. Try to run some helm commands that involve the plugin, or jump straight into plugin development.

Testing

To run tests, you need to have development environment set up.

This command does some preparations:

task setup

Run unit tests:

task test-unit

Run e2e tests:

task test-e2e