This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

Contributing Guidelines

This document describes how to contribute to the project.

Prerequisites

Go version 1.23+
A valid OpenShift Cluster Manager (OCM) token and logged in via ocm-cli or rosa
Access to ocm-backplane

Contributing steps

Submit an issue describing your proposed change
Fork the desired repo, develop and test your code changes
Submit a pull request

What to do before submitting a pull request

Ensure any additional AWS permissions are available in the STS Support Policy
Ensure the project builds and all tests pass
```
go test -v ./...
```

Test the change against a staging ROSA cluster

ocm-backplane tunnel -D
mirrosa -cluster-id "${CLUSTER_ID}"

New Releases

New releases are currently manually triggered via .github/workflows/release.yml and produce binaries and cosign to sign them.