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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document build and developer process. #188

Open
obnoxxx opened this issue Oct 2, 2023 · 4 comments
Open

document build and developer process. #188

obnoxxx opened this issue Oct 2, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@obnoxxx
Copy link
Contributor

obnoxxx commented Oct 2, 2023

The docs of this project doo not feature a guide how to build and test the plugin locally,

including instructions how to use a locally built plugin with kubectl.

@obnoxxx obnoxxx added the documentation Improvements or additions to documentation label Oct 2, 2023
@obnoxxx
Copy link
Contributor Author

obnoxxx commented Oct 2, 2023

@travisn , @subhamkrai - what do you think? - is this something that should be documented?

@obnoxxx obnoxxx changed the title document build an developer process. document build and developer process. Oct 2, 2023
@obnoxxx
Copy link
Contributor Author

obnoxxx commented Oct 2, 2023

I can confirm @BlaineEXE's suggestion from the huddle:

directly invoking bin/kubectl-rook-ceph works. no need to kubectl krew install it

@Javlopez
Copy link
Contributor

Javlopez commented Oct 3, 2023

Hi, could you add this as part of the developer guide?

Developer changes

We are adding unittests in order to ensure that the destroy-cluster command is working as we expected,
so if you want to expand the functionality, and you need to change the pgk/k8sutil/interface.go remember to recreate the mocks by using make generate

$ make generate
generating mocks...
completed
$

Run test

To run the tests you should to execute make test

$ make test
running unit tests
go test ./...
?   	github.com/rook/kubectl-rook-ceph/cmd	[no test files]
ok  	github.com/rook/kubectl-rook-ceph/cmd/commands	(cached)
ok  	github.com/rook/kubectl-rook-ceph/pkg/crds	(cached)
?   	github.com/rook/kubectl-rook-ceph/pkg/debug	[no test files]
?   	github.com/rook/kubectl-rook-ceph/pkg/dr	[no test files]
?   	github.com/rook/kubectl-rook-ceph/pkg/exec	[no test files]
?   	github.com/rook/kubectl-rook-ceph/pkg/health	[no test files]
?   	github.com/rook/kubectl-rook-ceph/pkg/k8sutil	[no test files]
?   	github.com/rook/kubectl-rook-ceph/pkg/logging	[no test files]
?   	github.com/rook/kubectl-rook-ceph/pkg/rook	[no test files]
ok  	github.com/rook/kubectl-rook-ceph/pkg/mons	(cached)
$

@travisn
Copy link
Member

travisn commented Oct 3, 2023

@Javlopez We will want the documentation for the destroy cluster command to be included with #173. Only the sections on the developer guide and running tests need to be in a developer guide for this issue. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants