chore: add more commands and refactor makefiles by Xunzhuo · Pull Request #113 · envoyproxy/gateway

Xunzhuo · 2022-06-17T09:29:18Z

Refactor makefiles and add more useful commands

➜  gateway git:(chore-build) make help           
Envoy Gateway is an open source project for managing Envoy Proxy as a standalone or Kubernetes-based application gateway

Usage: make <Targets> <Options> ...

Targets:
  build             Build envoy-gateway for host platform. See Option PLATFORM and BINS.
  image             Build docker images for host platform. See Option PLATFORM and BINS.
  push              Push docker images to registry.
  build.multiarch   Build envoy-gateway for multiple platforms. See Option PLATFORMS and IMAGES.
  image.multiarch   Build docker images for multiple platforms. See Option PLATFORMS and IMAGES.
  push.multiarch    Push docker images for multiple platforms to registry.
  lint              Run all linter of code sources, including golint, yamllint and codespell.
  test              Run all Go test of code sources.
  format            Format codes style with mod tidy, gofmt and goimports.
  clean             Remove all files that are created by building.
  help              Show this help info.

Options:
  BINS         The binaries to build. Default is all of cmd.
               This option is available when using: make build/build.multiarch
               Example: make build BINS="envoy-gateway"
  IMAGES       Backend images to make. Default is all of cmds.
               This option is available when using: make image/image.multiarch/push/push.multiarch
               Example: make image.multiarch IMAGES="envoy-gateway"
  PLATFORM     The specified platform to build.
               This option is available when using: make build/image
               Example: make build BINS="envoy-gateway" PLATFORM="linux_amd64"
               Supported Platforms: linux_amd64 linux_arm64 darwin_amd64 darwin_arm64
  PLATFORMS    The multiple platforms to build.
               This option is available when using: make build.multiarch
               Example: make image.multiarch IMAGES="envoy-gateway" PLATFORMS="linux_amd64 linux_arm64"
               Default is "linux_amd64 linux_arm64 darwin_amd64 darwin_arm64".

Signed-off-by: Xunzhuo mixdeers@gmail.com

youngnick

I think this looks pretty good overall, just needs a little more explanation so that people understand how the dynamic target building works.

Xunzhuo · 2022-06-20T05:54:44Z

Hi @youngnick, thanks for your kind reviews, more comments have been added.

codecov-commenter · 2022-06-20T07:53:41Z

Codecov Report

Merging #113 (a8c6e83) into main (884481c) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #113   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines            5         5           
=========================================
  Hits             5         5

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 884481c...a8c6e83. Read the comment docs.

danehans · 2022-06-27T16:20:10Z

@Xunzhuo can you respond to the review comments so this PR can proceed?

Xunzhuo · 2022-06-28T01:47:28Z

@Xunzhuo can you respond to the review comments so this PR can proceed?

Okay, I will work on this today.

danehans · 2022-06-28T16:22:41Z

@Xunzhuo the PR is now failing CI, PTAL.

Xunzhuo · 2022-06-30T05:39:25Z

Hi, CI has passed and reviews have been resolved. @arkodg

arkodg · 2022-06-30T05:49:29Z

looks like this wasn't reverted and bin/tmp is still being created

How about deleting bin/tmp automatically after building image?

the previous steps were one liners so prefer it over this

Signed-off-by: Xunzhuo <mixdeers@gmail.com> update Signed-off-by: Xunzhuo <mixdeers@gmail.com>

Signed-off-by: Xunzhuo <mixdeers@gmail.com>

arkodg

LGTM, thanks !

Signed-off-by: Xunzhuo <mixdeers@gmail.com>

* re add the kube make targets that were accidently removed as part of envoyproxy#113 * rm implementation for image.multiarch, which needs work * rm Makefile.targets.mk and reuse tools/make/common.mk * move top level targets to the right makefiles * move `make help` strings closer to the target ``` Envoy Gateway is an open source project for managing Envoy Proxy as a standalone or Kubernetes-based application gateway Usage: make <Targets> <Options> ... Targets: Usage: make <target> Golang build Build envoy-gateway for host platform. See Option PLATFORM and BINS. test Run all Go test of code sources. format Format codes style with mod tidy, gofmt and goimports. clean Remove all files that are created during builds. Image image Build docker images for host platform. See Option PLATFORM and BINS. push Push docker images to registry. Lint lint Run all linter of code sources, including golint, yamllint and codespell. Kubernetes Development manifests Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects. generate Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations. kube-test Run Kubernetes provider tests. Kubernetes Deployment kube-install Install CRDs into the Kubernetes cluster specified in ~/.kube/config. kube-uninstall Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion. Kubernetes Build Dependencies kustomize Download kustomize locally if necessary. controller-gen Download controller-gen locally if necessary. envtest Download envtest-setup locally if necessary. Options: BINS The binaries to build. Default is all of cmd. This option is available when using: make build/build.multiarch Example: make build BINS="envoy-gateway" IMAGES Backend images to make. Default is all of cmds. This option is available when using: make image/image.multiarch/push/push.multiarch Example: make image.multiarch IMAGES="envoy-gateway" PLATFORM The specified platform to build. This option is available when using: make build/image Example: make build BINS="envoy-gateway" PLATFORM="linux_amd64" Supported Platforms: linux_amd64 linux_arm64 darwin_amd64 darwin_arm64 PLATFORMS The multiple platforms to build. This option is available when using: make build.multiarch Example: make image.multiarch IMAGES="envoy-gateway" PLATFORMS="linux_amd64 linux_arm64" Default is "linux_amd64 linux_arm64 darwin_amd64 darwin_arm64". ``` Signed-off-by: Arko Dasgupta <arko@tetrate.io>

* re add the kube make targets that were accidently removed as part of #113 * rm implementation for image.multiarch, which needs work * rm Makefile.targets.mk and reuse tools/make/common.mk * move top level targets to the right makefiles * move `make help` strings closer to the target ``` Envoy Gateway is an open source project for managing Envoy Proxy as a standalone or Kubernetes-based application gateway Usage: make <Targets> <Options> ... Targets: Usage: make <target> Golang build Build envoy-gateway for host platform. See Option PLATFORM and BINS. test Run all Go test of code sources. format Format codes style with mod tidy, gofmt and goimports. clean Remove all files that are created during builds. Image image Build docker images for host platform. See Option PLATFORM and BINS. push Push docker images to registry. Lint lint Run all linter of code sources, including golint, yamllint and codespell. Kubernetes Development manifests Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects. generate Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations. kube-test Run Kubernetes provider tests. Kubernetes Deployment kube-install Install CRDs into the Kubernetes cluster specified in ~/.kube/config. kube-uninstall Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion. Kubernetes Build Dependencies kustomize Download kustomize locally if necessary. controller-gen Download controller-gen locally if necessary. envtest Download envtest-setup locally if necessary. Options: BINS The binaries to build. Default is all of cmd. This option is available when using: make build/build.multiarch Example: make build BINS="envoy-gateway" IMAGES Backend images to make. Default is all of cmds. This option is available when using: make image/image.multiarch/push/push.multiarch Example: make image.multiarch IMAGES="envoy-gateway" PLATFORM The specified platform to build. This option is available when using: make build/image Example: make build BINS="envoy-gateway" PLATFORM="linux_amd64" Supported Platforms: linux_amd64 linux_arm64 darwin_amd64 darwin_arm64 PLATFORMS The multiple platforms to build. This option is available when using: make build.multiarch Example: make image.multiarch IMAGES="envoy-gateway" PLATFORMS="linux_amd64 linux_arm64" Default is "linux_amd64 linux_arm64 darwin_amd64 darwin_arm64". ``` Signed-off-by: Arko Dasgupta <arko@tetrate.io>

…ions This was dropped in 80b78e5 AKA #113 Signed-off-by: Luke Shumaker <lukeshu@datawire.io>

* .gitignore: Begone with pointless **/ Entries in .gitignore aren't rooted unless they start with "/", so a leading "**/" is pointless. Signed-off-by: Luke Shumaker <lukeshu@datawire.io> * build-sys: Turn off intermediate file removal Signed-off-by: Luke Shumaker <lukeshu@datawire.io> * build-sys: Don't use recursive Make Arko had trouble with this, because variables were being used before they were defined. In order to make those errors easy to debug, I tacked on --warn-undefined-variables so that these things get called out. Signed-off-by: Luke Shumaker <lukeshu@datawire.io> * build-sys: Don't hide what commands are running Signed-off-by: Luke Shumaker <lukeshu@datawire.io> * .github: Refactor a bit, splitting things up Signed-off-by: Luke Shumaker <lukeshu@datawire.io> * build-sys, .github: Have CI use the combined `make lint` Rather tha calling each individually. Signed-off-by: Luke Shumaker <lukeshu@datawire.io> * build-sys: make lint: Restore integration with GitHub Actions annotations This was dropped in 80b78e5 AKA #113 Signed-off-by: Luke Shumaker <lukeshu@datawire.io> * build-sys: Introduce tools.mk to manage required tools Signed-off-by: Luke Shumaker <lukeshu@datawire.io> * build-sys: Begone with MAKE_IN_DOCKER Signed-off-by: Luke Shumaker <lukeshu@datawire.io>

Xunzhuo requested a review from a team as a code owner June 17, 2022 09:29

arkodg reviewed Jun 17, 2022

View reviewed changes

Comment thread Makefile.targets.mk Outdated

arkodg reviewed Jun 17, 2022

View reviewed changes

Comment thread Makefile.targets.mk Outdated

Xunzhuo requested a review from arkodg June 20, 2022 05:14

youngnick reviewed Jun 20, 2022

View reviewed changes

Comment thread Makefile.targets.mk Outdated

Xunzhuo force-pushed the chore-build branch 7 times, most recently from 4eb6395 to 9dec06e Compare June 20, 2022 07:53

Xunzhuo force-pushed the chore-build branch 4 times, most recently from e04a5fc to 2e86274 Compare June 20, 2022 08:24

Xunzhuo requested a review from youngnick June 20, 2022 10:02

danehans requested review from danehans and lizan and removed request for danehans June 20, 2022 15:59

arkodg reviewed Jun 21, 2022

View reviewed changes

Comment thread .github/workflows/build_and_test.yaml Outdated

arkodg reviewed Jun 21, 2022

View reviewed changes

Comment thread Makefile.targets.mk Outdated

arkodg mentioned this pull request Jun 29, 2022

optimize make #120

Closed

Xunzhuo force-pushed the chore-build branch 2 times, most recently from 21aee1a to 58f0e79 Compare June 29, 2022 07:29

Xunzhuo force-pushed the chore-build branch from c05454e to 6f38b7f Compare June 30, 2022 05:34

arkodg reviewed Jun 30, 2022

View reviewed changes

Comment thread .github/workflows/build_and_test.yaml Outdated

arkodg reviewed Jun 30, 2022

View reviewed changes

Comment thread go.sum Outdated

Xunzhuo force-pushed the chore-build branch from c9c10eb to 5f8fb9c Compare June 30, 2022 06:19

Xunzhuo commented Jun 30, 2022

View reviewed changes

Comment thread tools/make/image.mk Outdated

Xunzhuo force-pushed the chore-build branch from 11884b2 to 4e4c895 Compare June 30, 2022 06:28

feedback

e8de2d7

Signed-off-by: Xunzhuo <mixdeers@gmail.com> update Signed-off-by: Xunzhuo <mixdeers@gmail.com>

Xunzhuo force-pushed the chore-build branch from 4e4c895 to e8de2d7 Compare June 30, 2022 06:31

arkodg reviewed Jun 30, 2022

View reviewed changes

Comment thread .github/workflows/build_and_test.yaml Outdated

Xunzhuo force-pushed the chore-build branch from ac5f3ad to a8c6e83 Compare June 30, 2022 07:17

update

646c2f1

Signed-off-by: Xunzhuo <mixdeers@gmail.com>

Xunzhuo force-pushed the chore-build branch from a8c6e83 to 646c2f1 Compare June 30, 2022 07:44

arkodg previously approved these changes Jun 30, 2022

View reviewed changes

update

4791fbe

Signed-off-by: Xunzhuo <mixdeers@gmail.com>

Xunzhuo dismissed arkodg’s stale review via 4791fbe June 30, 2022 07:50

arkodg approved these changes Jun 30, 2022

View reviewed changes

arkodg merged commit 80b78e5 into envoyproxy:main Jun 30, 2022

arkodg mentioned this pull request Jun 30, 2022

make: re-add kube make targets #132

Merged

LukeShu added a commit that referenced this pull request Jul 6, 2022

build-sys: make lint: Restore integration with GitHub Actions annotat…

5f46065

…ions This was dropped in 80b78e5 AKA #113 Signed-off-by: Luke Shumaker <lukeshu@datawire.io>

LukeShu mentioned this pull request Jul 8, 2022

Remove MAKE_IN_DOCKER, and associated changes #129

Merged

LukeShu added a commit that referenced this pull request Jul 8, 2022

build-sys: make lint: Restore integration with GitHub Actions annotat…

77471cc

…ions This was dropped in 80b78e5 AKA #113 Signed-off-by: Luke Shumaker <lukeshu@datawire.io>

Conversation

Xunzhuo commented Jun 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

youngnick left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Xunzhuo commented Jun 20, 2022

Uh oh!

codecov-commenter commented Jun 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

danehans commented Jun 27, 2022

Uh oh!

Xunzhuo commented Jun 28, 2022

Uh oh!

danehans commented Jun 28, 2022

Uh oh!

Xunzhuo commented Jun 30, 2022

Uh oh!

Uh oh!

arkodg Jun 30, 2022

Choose a reason for hiding this comment

Uh oh!

Xunzhuo Jun 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arkodg Jun 30, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

arkodg left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Xunzhuo commented Jun 17, 2022 •

edited

Loading

codecov-commenter commented Jun 20, 2022 •

edited

Loading

Xunzhuo Jun 30, 2022 •

edited

Loading