From 13c9bc243b70ea1014a3094f5aebc8157721bb90 Mon Sep 17 00:00:00 2001 From: Harshdeep Singh <38904804+super-harsh@users.noreply.github.com> Date: Tue, 24 Dec 2024 08:08:52 +0530 Subject: [PATCH] Update dependencies documentation --- .devcontainer/install-dependencies.sh | 2 +- .../hugo/content/contributing/dependencies.md | 45 ++++++++++--------- 2 files changed, 24 insertions(+), 23 deletions(-) diff --git a/.devcontainer/install-dependencies.sh b/.devcontainer/install-dependencies.sh index dc7351ca13..83a5109727 100755 --- a/.devcontainer/install-dependencies.sh +++ b/.devcontainer/install-dependencies.sh @@ -221,7 +221,7 @@ go-install setup-envtest sigs.k8s.io/controller-runtime/tools/setup-envtest@late go-install gofumpt mvdan.cc/gofumpt@latest # Install golangci-lint -#doc# | golangci-lint | 1.61.0 | https://github.com/golangci/golangci-lint | +#doc# | golangci-lint | 1.62.0 | https://github.com/golangci/golangci-lint | write-verbose "Checking for $TOOL_DEST/golangci-lint" if should-install "$TOOL_DEST/golangci-lint"; then write-info "Installing golangci-lint" diff --git a/docs/hugo/content/contributing/dependencies.md b/docs/hugo/content/contributing/dependencies.md index 6bdb34b805..b34df741e7 100644 --- a/docs/hugo/content/contributing/dependencies.md +++ b/docs/hugo/content/contributing/dependencies.md @@ -6,28 +6,29 @@ Development of Azure Service Operator depends on a number of development tools a If you prefer to install those dependencies manually (instead of using the `.devcontainer/install-dependencies.sh` script), here is a list of what's required. -| Dependency | Version | Reference | -|:---------------------------|:--------:|:----------------------------------------------------------------------------------------------------------------| -| AZ | latest | https://docs.microsoft.com/en-us/cli/azure/install-azure-cli | -| AZWI | v1.2.0 | https://github.com/Azure/azure-workload-identity | -| BuildX | v0.11.2 | https://github.com/docker/buildx | -| cmctl | latest | https://cert-manager.io/docs/reference/cmctl | -| controller-gen | v0.14.0 | https://book.kubebuilder.io/reference/controller-gen | -| conversion-gen | v0.28.8 | https://pkg.go.dev/k8s.io/code-generator/cmd/conversion-gen | -| gen-crd-api-reference-docs | 11fe95cb | https://github.com/ahmetb/gen-crd-api-reference-docs | -| Go | 1.23 | https://golang.org/doc/install # | -| gofumpt | latest | https://pkg.go.dev/mvdan.cc/gofumpt | -| golangci-lint | 1.51.2 | https://github.com/golangci/golangci-lint | -| Helm | v3.8.0 | https://helm.sh/ | -| htmltest | latest | https://github.com/wjdp/htmltest (but see https://github.com/theunrepentantgeek/htmltest for our custom build ) | -| hugo | v0.88.1 | https://gohugo.io/ | -| kind | v0.20.0 | https://kind.sigs.k8s.io/ | -| kustomize | v4.5.7 | https://kustomize.io/ | -| PostCSS | latest | https://postcss.org/ | -| setup-envtest | latest | https://book.kubebuilder.io/reference/envtest.html | -| Task | v3.31 | https://taskfile.dev/ | -| Trivy | v0.37.3 | https://trivy.dev/ | -| YQ | v4.13.0 | https://github.com/mikefarah/yq/ | +| Dependency | Version | Reference | +|:---------- |:-------:|:--------- | +| AZ | latest | https://docs.microsoft.com/en-us/cli/azure/install-azure-cli | +| AZWI | v1.2.0 | https://github.com/Azure/azure-workload-identity | +| BuildX | v0.17.1 | https://github.com/docker/buildx | +| cmctl | latest | https://cert-manager.io/docs/reference/cmctl | +| controller-gen | v0.16.3 | https://book.kubebuilder.io/reference/controller-gen | +| conversion-gen | v0.30.5 | https://pkg.go.dev/k8s.io/code-generator/cmd/conversion-gen | +| gen-crd-api-reference-docs | 11fe95cb | https://github.com/ahmetb/gen-crd-api-reference-docs | +| Go | 1.23 | https://golang.org/doc/install # +| gofumpt | latest | https://pkg.go.dev/mvdan.cc/gofumpt | +| golangci-lint | 1.62.0 | https://github.com/golangci/golangci-lint | +| Helm | v3.16.1 | https://helm.sh/ | +| htmltest | latest | https://github.com/wjdp/htmltest (but see https://github.com/theunrepentantgeek/htmltest for our custom build ) +| hugo | v0.135.0 | https://gohugo.io/ | +| kind | v0.24.0 | https://kind.sigs.k8s.io/ | +| kustomize | v4.5.7 | https://kustomize.io/ | +| Pip3 | latest | https://pip.pypa.io/en/stable/installation/ | +| PostCSS | latest | https://postcss.org/ | +| setup-envtest | latest | https://book.kubebuilder.io/reference/envtest.html | +| Task | v3.39.2 | https://taskfile.dev/ | +| Trivy | v0.55.2 | https://trivy.dev/ | +| YQ | v4.44.3 | https://github.com/mikefarah/yq/ | Dependencies are listed alphabetically. Refer to `install-dependencies.sh` for a recommended order of installation.