contributing-via-pr.md

Submitting your Operator via Pull Requests (PR) in community operators project

Overview

To submit an operator one has to do these steps

1. Fork project https://github.com/redhat-openshift-ecosystem/community-operators-prod
2. Make a pull request
3. Place the operator in the target directory. More info
   • operators
4. Configure ci.yaml file. More info
   • Setup reviewers
   • Operator versioning strategy
5. Verify tests and fix problems, if possible
6. Ask for help in the PR in case of problems

Pull request

When a pull request is created, a number of tests are executed via community hosted pipeline. One can see the results in the comment section of conversation tab.

You are done

User is done when all tests are green. When the PR is merged, the community release pipeline will be triggered.

Test results failed?

When operator tests are failing, one can see a following picture

In case of failures, please have a look at the logs of specific tests. If an error is not clear to you, please ask in the PR. Maintainers will be happy to help you with it.

Useful commands interacting with the pipeline

You can post the following comment/command:

Command	Functionality
/pipeline restart community-hosted-pipeline	The hosted pipeline will be re-triggered and PR will be merged if possible.
/pipeline restart community-release-pipeline	The release pipeline will be re-triggered.