-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
# Use `replaces-mode` or `semver-mode`. Once you switch to `semver-mode`, there is no easy way back. | ||
updateGraph: semver-mode | ||
addReviewers: true | ||
reviewers: | ||
- sabre1041 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
### New Submissions | ||
* [ ] Has you operator [nested directory structure](https://github.com/operator-framework/community-operators/blob/master/docs/contributing.md#create-a-bundle)? | ||
* [ ] Have you selected the Project *Community Operator Submissions* in your PR on the right-hand menu bar? | ||
* [ ] Are you familiar with our [contribution guidelines](https://github.com/operator-framework/community-operators/blob/master/docs/contributing.md)? | ||
* [ ] Have you [packaged and deployed](https://github.com/operator-framework/community-operators/blob/master/docs/testing-operators.md) your Operator for Operator Framework? | ||
* [ ] Have you tested your Operator with all Custom Resource Definitions? | ||
* [ ] Have you tested your Operator in all supported [installation modes](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md#operator-metadata)? | ||
* [ ] Is your submission [signed](https://github.com/operator-framework/community-operators/blob/master/docs/contributing.md#sign-your-work)? | ||
### Updates to existing Operators | ||
* [x] Is your new CSV pointing to the previous version with the `replaces` property? | ||
* [x] Is your new CSV referenced in the [appropriate channel](https://github.com/operator-framework/community-operators/blob/master/docs/contributing.md#bundle-format) defined in the `package.yaml` ? | ||
* [ ] Have you tested an update to your Operator when deployed via OLM? | ||
* [x] Is your submission [signed](https://github.com/operator-framework/community-operators/blob/master/docs/contributing.md#sign-your-work)? | ||
### Your submission should not | ||
* [x] Modify more than one operator | ||
* [x] Modify an Operator you don't own | ||
* [x] Rename an operator - please remove and add with a different name instead | ||
* [x] Submit operators to both `upstream-community-operators` and `community-operators` at once | ||
* [x] Modify any files outside the above mentioned folders | ||
* [x] Contain more than one commit. **Please squash your commits.** | ||
### Operator Description must contain (in order) | ||
1. [x] Description about the managed Application and where to find more information | ||
2. [x] Features and capabilities of your Operator and how to use it | ||
3. [x] Any manual steps about potential pre-requisites for using your Operator | ||
### Operator Metadata should contain | ||
* [x] Human readable name and 1-liner description about your Operator | ||
* [x] Valid [category name](https://github.com/operator-framework/community-operators/blob/master/docs/required-fields.md#categories)<sup>1</sup> | ||
* [x] One of the pre-defined [capability levels](https://github.com/operator-framework/operator-courier/blob/4d1a25d2c8d52f7de6297ec18d8afd6521236aa2/operatorcourier/validate.py#L556)<sup>2</sup> | ||
* [x] Links to the maintainer, source code and documentation | ||
* [x] Example templates for all Custom Resource Definitions intended to be used | ||
* [x] A quadratic logo | ||
Remember that you can preview your CSV [here](https://operatorhub.io/preview). | ||
-- | ||
<sup>1</sup> If you feel your Operator does not fit any of the pre-defined categories, file a PR against this repo and explain your need | ||
<sup>2</sup> For more information see [here](https://github.com/operator-framework/operator-sdk/blob/master/doc/images/operator-capability-level.svg) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
### New Submissions | ||
* [x] Has you operator [nested directory structure](https://github.com/operator-framework/community-operators/blob/master/docs/contributing.md#create-a-bundle)? | ||
* [x] Have you selected the Project *Community Operator Submissions* in your PR on the right-hand menu bar? | ||
* [x] Are you familiar with our [contribution guidelines](https://github.com/operator-framework/community-operators/blob/master/docs/contributing.md)? | ||
* [x] Have you [packaged and deployed](https://github.com/operator-framework/community-operators/blob/master/docs/testing-operators.md) your Operator for Operator Framework? | ||
* [x] Have you tested your Operator with all Custom Resource Definitions? | ||
* [x] Have you tested your Operator in all supported [installation modes](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md#operator-metadata)? | ||
* [x] Is your submission [signed](https://github.com/operator-framework/community-operators/blob/master/docs/contributing.md#sign-your-work)? | ||
### Updates to existing Operators | ||
* [ ] Is your new CSV pointing to the previous version with the `replaces` property? | ||
* [ ] Is your new CSV referenced in the [appropriate channel](https://github.com/operator-framework/community-operators/blob/master/docs/contributing.md#bundle-format) defined in the `package.yaml` ? | ||
* [ ] Have you tested an update to your Operator when deployed via OLM? | ||
* [ ] Is your submission [signed](https://github.com/operator-framework/community-operators/blob/master/docs/contributing.md#sign-your-work)? | ||
### Your submission should not | ||
* [x] Modify more than one operator | ||
* [x] Modify an Operator you don't own | ||
* [x] Rename an operator - please remove and add with a different name instead | ||
* [x] Submit operators to both `upstream-community-operators` and `community-operators` at once | ||
* [x] Modify any files outside the above mentioned folders | ||
* [x] Contain more than one commit. **Please squash your commits.** | ||
### Operator Description must contain (in order) | ||
1. [x] Description about the managed Application and where to find more information | ||
2. [x] Features and capabilities of your Operator and how to use it | ||
3. [x] Any manual steps about potential pre-requisites for using your Operator | ||
### Operator Metadata should contain | ||
* [x] Human readable name and 1-liner description about your Operator | ||
* [x] Valid [category name](https://github.com/operator-framework/community-operators/blob/master/docs/required-fields.md#categories)<sup>1</sup> | ||
* [x] One of the pre-defined [capability levels](https://github.com/operator-framework/operator-courier/blob/4d1a25d2c8d52f7de6297ec18d8afd6521236aa2/operatorcourier/validate.py#L556)<sup>2</sup> | ||
* [x] Links to the maintainer, source code and documentation | ||
* [x] Example templates for all Custom Resource Definitions intended to be used | ||
* [x] A quadratic logo | ||
Remember that you can preview your CSV [here](https://operatorhub.io/preview). | ||
-- | ||
<sup>1</sup> If you feel your Operator does not fit any of the pre-defined categories, file a PR against this repo and explain your need | ||
<sup>2</sup> For more information see [here](https://github.com/operator-framework/operator-sdk/blob/master/doc/images/operator-capability-level.svg) |