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

Review/extend DEVELOPMENT documentation #341

Closed
Tracked by #133
dholbach opened this issue Oct 18, 2021 · 3 comments · Fixed by #397
Closed
Tracked by #133

Review/extend DEVELOPMENT documentation #341

dholbach opened this issue Oct 18, 2021 · 3 comments · Fixed by #397
Labels
area/docs Documentation related issues and pull requests good first issue Good for newcomers

Comments

@dholbach
Copy link
Member

Each of the controllers should have clear guidelines on how to build and run the
projects. This includes the sections:
○ How to install dependencies
○ How to install the controller
○ How to run the test suite locally
○ How to run the controller locally

Some of the information might already be there - let's double-check it's up to date and accurate.

@dholbach dholbach added this to To do in Audit Follow-Up Oct 18, 2021
@dholbach
Copy link
Member Author

Please note this file has moved to https://github.com/fluxcd/helm-controller/blob/main/DEVELOPMENT.md now

@dholbach
Copy link
Member Author

This issue might be well-suited for new contributors. Basically the ask is: if you have a fairly clean installation of whatever your OS is: let us know if the instructions in the file above were everything that's needed to get you going on the individual tasks. Please report back if you ran into issues and the docs should be clearer (or make a PR!). Thanks a lot in advance!

@makkes makkes added area/docs Documentation related issues and pull requests good first issue Good for newcomers labels Oct 29, 2021
@dholbach dholbach removed this from To do in Audit Follow-Up Nov 10, 2021
@dholbach dholbach changed the title Review/extend CONTRIBUTING documentation Review/extend DEVELOPMENT documentation Nov 10, 2021
@cebernardi
Copy link
Contributor

Hi all!
I was recently trying to set up the project and run the tests (MacOS environment) and I noticed that:

  • tests fail to run if one doesn't have kubebuilder-tools installed (unable to start control plane itself: failed to start the controlplane. retried 5 times: fork/exec /usr/local/kubebuilder/bin/etcd: no such file or directory); I see that there is already a possibly related open issue
  • version 0.5.0+ of controller-gen should be enforced (
    go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.5.0 ;\
    ); I had 0.4.0 and the Makefile target did not download a new version, so I run into the controller-gen bug where negative values are generated as strings (here the bug and here the bit that was failing for me)

I see that the new projects generated with kubeebuilder adopt a different approach and download both controller-gen and test-env into a local folder, so only the project scope is affected.

If there is consensus I could adapt the Makefile to this approach as well.

Otherwise, I could just add some lines to the DEVELOPMENT.md where I list the above as manual steps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants