mirror of
https://github.com/external-secrets/external-secrets.git
synced 2024-12-14 11:57:59 +00:00
7b883778e9
* feat: add docs Signed-off-by: Moritz Johner <beller.moritz@googlemail.com>
53 lines
1.4 KiB
Bash
Executable file
53 lines
1.4 KiB
Bash
Executable file
#!/bin/bash
|
|
|
|
# Copyright 2020 The Kubernetes Authors.
|
|
#
|
|
# 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 -o errexit
|
|
set -o nounset
|
|
set -o pipefail
|
|
|
|
GOPATH=${GOPATH:-$(go env GOPATH)}
|
|
|
|
# "go env" doesn't print anything if GOBIN is the default, so we
|
|
# have to manually default it.
|
|
GOBIN=${GOBIN:-$(go env GOBIN)}
|
|
GOBIN=${GOBIN:-${GOPATH}/bin}
|
|
|
|
readonly HERE=$(cd $(dirname $0) && pwd)
|
|
readonly REPO=$(cd ${HERE}/../.. && pwd)
|
|
|
|
gendoc::build() {
|
|
go install github.com/ahmetb/gen-crd-api-reference-docs
|
|
}
|
|
|
|
# Exec the doc generator.
|
|
gendoc::exec() {
|
|
local readonly confdir="${REPO}/hack/api-docs"
|
|
|
|
${GOBIN}/gen-crd-api-reference-docs \
|
|
-template-dir ${confdir} \
|
|
-config ${confdir}/config.json \
|
|
"$@"
|
|
}
|
|
|
|
if [ "$#" != "1" ]; then
|
|
echo "usage: generate.sh OUTFILE"
|
|
exit 2
|
|
fi
|
|
|
|
gendoc::build
|
|
gendoc::exec \
|
|
-api-dir github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1 \
|
|
-out-file "$1"
|