Project: Pluto (Provisioning / Security & Compliance)
File: guide.md

meta: name: description content: "Fairwinds Pluto | Contribution Guidelines" Issues, whether bugs, tasks, or feature requests are essential for keeping pluto great. We believe it should be as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can keep on top of things. This project adheres to a . Please review this document before contributing to this project. Before you can contribute, you will need to sign the . pluto is a relatively simple cobra cli tool that helps deal with deprecated api versions in Kubernetes. The folder contains the flags and other cobra config, while the folder has the various packages. This contains the various structs and helper functions to deal with Kubernetes objects and their apiVersions. It assumes that any file we care about will have a `Kind` and an `apiVersion`. This package is for dealing with a set of static files and analyzing the apiVersions in them. It can search through a directory and find any files that conform to the specifications of the versions package. This package deals with finding helm release manifests that are in your running Kubernetes cluster. The versions.yaml file contains the source of truth for the standard list of deprecated versions that Pluto can deal with. If you wish to update it or change the default targetVersions, it is easiest to use Pluto to do that. Just create a deprecated-versions yaml file that has the additional versions and/or target versions you wish to edit. Here's an example: ``` target-versions: other: v1.0.0 deprecated-versions: version: someother/v1beta1 kind: AnotherCRD deprecated-in: v1.9.0 removed-in: v1.16.0 replacement-api: apps/v1 component: new-component ``` Put this somewhere temporary, like /tmp/new.yaml. Then you can run: ``` pluto list-versions -f /tmp/new.yaml -oyaml > versions.yaml ``` This will ensure that you have parsable valid versions, and it should make patching easier. We label issues with the if we believe they'll be a good starting point for new contributors. If you're interested in working on an issue, please start a conversation on that issue, and we can help answer any questions as they come up. A properly configured Golang environment with Go 1.13 or higher Install `pkger` - Clone the project with `go get github.com/fairwindsops/pluto` Change into the pluto directory which is installed at `$GOPATH/src/github.com/fairwindsops/pluto` Use `make build` to build the binary locally. Use `make test` to run the tests and generate a coverage report. If you've encountered an issue that is not already reported, please create an issue that contains the following: Clear description of the issue Steps to reproduce it Appropriate labels Each new pull request should: Reference any related issues Add tests that show the issues have been solved Pass existing tests and linting Contain a clear indication of if they're ready for review or a work in progress Be up to date and/or rebased on the master branch There is a Makefile that can assist in validating and testing the orb locally. See the commands there for more info. Push a new annotated tag. This tag should contain a changelog of pertinent changes. Goreleaser will take care of the rest. This repo contains a pre-commit file for use with . Just run `pre-commit install` and you will have the hooks.