Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add note about chainsaw #6675

Merged
merged 1 commit into from
Feb 20, 2024

Conversation

eddycharly
Copy link
Contributor

@eddycharly eddycharly commented Feb 8, 2024

Description of the change:

Add note about chainsaw in the docs.

If you need more infos 馃憞

Motivation for the change:

We presented chainsaw to the community meeting last week and received good feedback.
It would be awesome to have it listed in the docs.

Checklist

If the pull request includes user-facing changes, extra documentation is required:

@eddycharly
Copy link
Contributor Author

cc @camilamacedo86 @varshaprasad96

@camilamacedo86
Copy link
Contributor

camilamacedo86 commented Feb 8, 2024

Following the discussion we had via Slack, I wanted to share some thoughts on the PR.

The operator-sdk includes a feature called scorecard, which utilizes kuttl. This is the reason kuttl is mentioned in the documentation. However, chainsaw is not included or shipped with the project (or is the core of any test feature supported by it). Therefore, I'm not sure if it's appropriate to include it in the documentation.

Including chainsaw might lead the operator-sdk maintainers into a situation where they have to answer questions and provide support for a tool that is not a direct part of the project. It can be challenging for maintainers to support third-party tools and integrations.

I am no longer an active maintainer of the SDK project, so I'll leave the decision to those currently maintaining the project to determine what best fits their strategy.

@eddycharly
Copy link
Contributor Author

Thanks for chiming in @camilamacedo86 !

Operator SDK can support chainsaw scorecard test, here is the PR #6676 馃槃

I'm fine with answering chainsaw related questions if any.

@eddycharly
Copy link
Contributor Author

@jberkhahn do you have any suggestion after the yesterday meeting ? what is the next step ?

Copy link
Member

@varshaprasad96 varshaprasad96 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. As a scaffolding tool we are listing the possible options and redirecting user to the external documentation.

Thanks for the PR @eddycharly!
/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 16, 2024
@eddycharly
Copy link
Contributor Author

Thanks @varshaprasad96 馃槏

Do I need to fix something ?

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Feb 16, 2024
Copy link

openshift-ci bot commented Feb 16, 2024

New changes are detected. LGTM label has been removed.

Signed-off-by: Charles-Edouard Br茅t茅ch茅 <charles.edouard@nirmata.com>
@eddycharly
Copy link
Contributor Author

@varshaprasad96 i lost your LGTM 馃檹

@varshaprasad96
Copy link
Member

Going to go ahead and merge this, as it has been open for review for a few days! If folks have any issues/further discussions w.r.t to this PR, please feel free to create issues :)

@varshaprasad96 varshaprasad96 merged commit 1a62a43 into operator-framework:master Feb 20, 2024
21 checks passed
@eddycharly eddycharly deleted the patch-1 branch February 20, 2024 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants