Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (40 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 1.33 KB

Contributing

THis project uses Makefile to manage common tasks. You can see all available commands by running:

make help

Ensure your environment provides the encessary tools to build and test the project.

  • Go in the version specified in go.mod
  • Docker or a compatible container runtime
## Developing

Install the required submodules to build and run:

```bash
make submodules

Apply the Current CRDs and a providerConfig:

kubectl apply -f package/crds
kubectl apply -f examples/providerconfig/providerconfig.yaml

Run against a Kubernetes cluster: (make sure to apply CRDs and providerConfig)

make run

Run a testbuild with linting:

make reviewable

Build binary:

make build

Release a new version (Maintainer)

  • Update Changelog (Add new Version & Date)
  • Create or merge to existing release branch (release-v(major).(minor))
  • Ensure that all tests pass (CI pipeline is okay)
  • Run Tag pipeline on the release branch
  • Run Release Provider Package pipeline on the tag

Environment Specific Notes

Apple Silicon (ARM64)