Clean makefile #1532
Merged
Clean makefile #1532
Conversation
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
ozamosi
approved these changes
Feb 25, 2022
dhwthompson
reviewed
Feb 25, 2022
README.md
Outdated
|
|
||
| This is a list of the tools you may need to install: | ||
|
|
||
| * [go](go.dev) -- Primary compiler for the CLI. |
There was a problem hiding this comment.
GitHub gets confused when URLs look like relative URLs.
Suggested change
| * [go](go.dev) -- Primary compiler for the CLI. | |
| * [go](https://go.dev) -- Primary compiler for the CLI. |
README.md
Outdated
| Some other tools are installed automatically by the makefile for you: | ||
|
|
||
| * [go-acc](https://github.com/ory/go-acc) -- Calculates code coverage for go. | ||
| * [gcov2lcov](github.com/jandelgado/gcov2lcov) -- Converts output from go-acc to a format lcov understands. |
There was a problem hiding this comment.
Suggested change
| * [gcov2lcov](github.com/jandelgado/gcov2lcov) -- Converts output from go-acc to a format lcov understands. | |
| * [gcov2lcov](https://github.com/jandelgado/gcov2lcov) -- Converts output from go-acc to a format lcov understands. |
README.md
Outdated
|
|
||
| * [go-acc](https://github.com/ory/go-acc) -- Calculates code coverage for go. | ||
| * [gcov2lcov](github.com/jandelgado/gcov2lcov) -- Converts output from go-acc to a format lcov understands. | ||
| * [controller-gen](sigs.k8s.io/controller-tools/cmd/controller-gen) -- Helps generate kubernetes controller code. |
There was a problem hiding this comment.
Suggested change
| * [controller-gen](sigs.k8s.io/controller-tools/cmd/controller-gen) -- Helps generate kubernetes controller code. | |
| * [controller-gen](https://sigs.k8s.io/controller-tools/cmd/controller-gen) -- Helps generate kubernetes controller code. |
| @@ -75,6 +75,33 @@ To set up a development environment for the CLI | |||
| 6. Start the in-cluster API replacement job (powered by [http://tilt.dev](tilt.dev)) with `make cluster-dev` | |||
| 7. make or make unit-tests to ensure everything built correctly. | |||
|
|
|||
| ### Requirements/tools | |||
There was a problem hiding this comment.
🎉👍🧁 for extra documentation.
ozamosi
pushed a commit
that referenced
this pull request
Feb 28, 2022
This just calls "flux" instead of a specific path - it has the neat side-effect that instead of using WEAVE_GITOPS_FLUX_BIN_PATH, you can just set your own flux bin path using the PATH variable. Right now, there are only two things we do with this flux: creating a secret, and wrapping `flux check` in `gitops check`. The gitops check should end up removing the flux check. The secret is part of accessing private git repos, which is called by auth which is called by both upgrade and profiles. There's still a flux installed by `make dependencies` - I've adapted the auth tests to use the one installed by that, but as it's not added to your path, it's not going to be used by the local CLI. Flux is now a dependency I expect you to install yourself (will not document right now, but note to self to add to the documentation #1532 is adding).
ozamosi
pushed a commit
that referenced
this pull request
Feb 28, 2022
This means that from now on, there's one allowed version of the buf toolchain, however that toolchain should be installed by just running `make proto`. I stole this from #1532, and extended it with the buf command itself as well.
ozamosi
pushed a commit
that referenced
this pull request
Feb 28, 2022
This means that from now on, there's one allowed version of the buf toolchain, however that toolchain should be installed by just running `make proto`. I stole this from #1532, and extended it with the buf command itself as well. This also upgrades grpc, in order to support buf 1.0.
added 4 commits
March 2, 2022 11:44
This should surpress warnings when building UI components without go installed.
The `cmd/gitops/ui/run/dist/{,index.html}` targets create an empty
directory and file respectively and are only used in github workflows to
avoid git errors due to missing embed targets. This removes them in
favour of making it clear in the github actions that nothing is actually
being made.
This also re-orders the dependencies for the ui-lib target within the
makefile to make it clearer what lives with what
We should be clear about the tools used to build gitops
Some common patterns in the github workflows is to either create a fake ui dist or flux file (`mkdir ... && touch ...`) or to run `npm ci` then separately generate the ui. The former can now be removed as the directories to be embedded have had keep files added while the latter can be replaced with the simple `make ui` which performs all necessary steps to generate the ui.
ozamosi
pushed a commit
that referenced
this pull request
Mar 3, 2022
This just calls "flux" instead of a specific path - it has the neat side-effect that instead of using WEAVE_GITOPS_FLUX_BIN_PATH, you can just set your own flux bin path using the PATH variable. Right now, there are only two things we do with this flux: creating a secret, and wrapping `flux check` in `gitops check`. The gitops check should end up removing the flux check. The secret is part of accessing private git repos, which is called by auth which is called by both upgrade and profiles. There's still a flux installed by `make dependencies` - I've adapted the auth tests to use the one installed by that, but as it's not added to your path, it's not going to be used by the local CLI. Flux is now a dependency I expect you to install yourself (will not document right now, but note to self to add to the documentation #1532 is adding).
jpellizzari
pushed a commit
that referenced
this pull request
Mar 3, 2022
This means that from now on, there's one allowed version of the buf toolchain, however that toolchain should be installed by just running `make proto`. I stole this from #1532, and extended it with the buf command itself as well. This also upgrades grpc, in order to support buf 1.0.
ozamosi
pushed a commit
that referenced
this pull request
Mar 7, 2022
This just calls "flux" instead of a specific path - it has the neat side-effect that instead of using WEAVE_GITOPS_FLUX_BIN_PATH, you can just set your own flux bin path using the PATH variable. Right now, there are only two things we do with this flux: creating a secret, and wrapping `flux check` in `gitops check`. The gitops check should end up removing the flux check. The secret is part of accessing private git repos, which is called by auth which is called by both upgrade and profiles. There's still a flux installed by `make dependencies` - I've adapted the auth tests to use the one installed by that, but as it's not added to your path, it's not going to be used by the local CLI. Flux is now a dependency I expect you to install yourself (will not document right now, but note to self to add to the documentation #1532 is adding).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes: #1477
What changed?
bufWhy?
This should improve the developer experience and make understanding various workflows easier.
How did you test it?
As much as possible changes have been tested (albeit only on a mac)