Fork helm-operator adjustments for CI and documentation #4
Conversation
SimonBaeumer
changed the title
README.md
Outdated
|
|
||
| Experimental refactoring of the operator-framework's helm operator | ||
|
|
||
| ### Why a fork? |
There was a problem hiding this comment.
@gaurav-nelson Do you have any feedback for me here?
I would like to say that this is a fork which diverges in its use-case from the original operator implementation.
There was a problem hiding this comment.
I guess it would be good to have some convention how to label commits for easier upstreaming our changes. For example, this commit must not be picked for upstreaming and can be marked somehow like [not for upstream] Fork helm-operator adjustments for CI and documentation.
What do you think?
| - '**' | ||
| pull_request: | ||
| branches: [ main ] | ||
| - push |
There was a problem hiding this comment.
Curious as to why you changed this?
There was a problem hiding this comment.
Because the CI was not triggered in the default setting.
README.md
Outdated
| As the helm-operator is an experimental refactoring and not actively maintained we started a fork to | ||
| further support [hybrid operators](https://github.com/operator-framework/operator-sdk/issues/670) based on Helm. | ||
|
|
||
| This fork should used as a library and not is recommended to watch CustomResources by configured `watches`. |
There was a problem hiding this comment.
I don't understand this sentence, or how "watching CustomResources by configured watches" relates to whether or not it's being used as a library
There was a problem hiding this comment.
Rephrased the whole paragraph.
README.md
Outdated
| Add this lib as a replace directive to your `go.mod`: | ||
|
|
||
| ``` | ||
| replace( |
There was a problem hiding this comment.
super nit: it's common to just provide a CLI command, e.g., go mod edit -replace=github.com/joelanford/helm-operator=github.com/stackrox/helm-operator@main (also, the line as it's written is invalid, as you need to specify a revision for the replacement module)
👍 |
CI migration of the helm-operator fork.
Did not deleted the original deploy actions.