Skip to content

hack: update ref docs gen script to cleanup tmp dirs #1001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 15, 2019
Merged

hack: update ref docs gen script to cleanup tmp dirs #1001

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dce4c89
hack: update ref docs gen script to cleanup tmp dirs
ahmetb Mar 14, 2019
291600c
Merge branch 'master' into gendoc-cleanup
RichieEscarez Mar 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 37 additions & 19 deletions hack/gen-api-reference-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ KNATIVE_EVENTING_SOURCES_REPO="github.com/knative/eventing-sources"
KNATIVE_EVENTING_SOURCES_COMMIT="${KNATIVE_EVENTING_SOURCES_COMMIT:?specify the \$KNATIVE_EVENTING_SOURCES_COMMIT variable}"
KNATIVE_EVENTING_SOURCES_OUT_FILE="eventing/eventing-sources.md"

cleanup_refdocs_root=
cleanup_repo_clone_root=
trap cleanup EXIT

log() {
echo "$@" >&2
}
Expand Down Expand Up @@ -89,21 +93,32 @@ clone_at_commit() {
}

gen_refdocs() {
local refdocs_bin gopath out_file repo_root
local refdocs_bin gopath out_dir out_file repo_root
refdocs_bin="$1"
gopath="$2"
out_file="$3"
repo_root="$4"
out_dir="$3"
out_file="$4"
repo_root="$5"

(
cd "${repo_root}"
env GOPATH="${gopath}" "${refdocs_bin}" \
-out-file "${gopath}/out/${out_file}" \
-out-file "${out_dir}/${out_file}" \
-api-dir "./pkg/apis" \
-config "${SCRIPTDIR}/reference-docs-gen-config.json"
)
}

cleanup() {
if [ -d "${cleanup_refdocs_root}" ]; then
echo "Cleaning up tmp directory: ${cleanup_refdocs_root}"
rm -rf -- "${cleanup_refdocs_root}"
fi
if [ -d "${cleanup_repo_clone_root}" ]; then
echo "Cleaning up tmp directory: ${cleanup_repo_clone_root}"
rm -rf -- "${cleanup_repo_clone_root}"
fi
}

main() {
if [[ -n "${GOPATH:-}" ]]; then
Expand All @@ -119,53 +134,56 @@ main() {
# install and place the refdocs tool
local refdocs_bin refdocs_bin_expected refdocs_dir
refdocs_dir="$(mktemp -d)"
refdocs_bin="${refdocs_dir}/refdocs"
cleanup_refdocs_root="${refdocs_dir}"
# clone repo for ./templates
git clone --quiet --depth=1 "${REFDOCS_REPO}" "${refdocs_dir}"
# install bin
install_go_bin "${REFDOCS_PKG}@${REFDOCS_VER}"
# move bin to final location
refdocs_bin="${refdocs_dir}/refdocs"
refdocs_bin_expected="$(go env GOPATH)/bin/$(basename ${REFDOCS_PKG})"
mv "${refdocs_bin_expected}" "${refdocs_bin}"
[[ ! -f "${refdocs_bin}" ]] && fail "refdocs failed to install"

local clone_root
local clone_root out_dir
clone_root="$(mktemp -d)"
cleanup_repo_clone_root="${clone_root}"
out_dir="$(mktemp -d)"

local knative_serving_root
knative_serving_root="${clone_root}/src/${KNATIVE_SERVING_REPO}"
clone_at_commit "https://${KNATIVE_SERVING_REPO}.git" "${KNATIVE_SERVING_COMMIT}" \
"${knative_serving_root}"
gen_refdocs "${refdocs_bin}" "${clone_root}" "${KNATIVE_SERVING_OUT_FILE}" \
"${knative_serving_root}"
gen_refdocs "${refdocs_bin}" "${clone_root}" "${out_dir}" \
"${KNATIVE_SERVING_OUT_FILE}" "${knative_serving_root}"

local knative_build_root
knative_build_root="${clone_root}/src/${KNATIVE_BUILD_REPO}"
clone_at_commit "https://${KNATIVE_BUILD_REPO}.git" "${KNATIVE_BUILD_COMMIT}" \
"${knative_build_root}"
gen_refdocs "${refdocs_bin}" "${clone_root}" "${KNATIVE_BUILD_OUT_FILE}" \
"${knative_build_root}"
gen_refdocs "${refdocs_bin}" "${clone_root}" "${out_dir}" \
"${KNATIVE_BUILD_OUT_FILE}" "${knative_build_root}"

local knative_eventing_root
knative_eventing_root="${clone_root}/src/${KNATIVE_EVENTING_REPO}"
clone_at_commit "https://${KNATIVE_EVENTING_REPO}.git" "${KNATIVE_EVENTING_COMMIT}" \
"${knative_eventing_root}"
gen_refdocs "${refdocs_bin}" "${clone_root}" "${KNATIVE_EVENTING_OUT_FILE}" \
"${knative_eventing_root}"
gen_refdocs "${refdocs_bin}" "${clone_root}" "${out_dir}" \
"${KNATIVE_EVENTING_OUT_FILE}" "${knative_eventing_root}"

local knative_eventing_sources_root
knative_eventing_sources_root="${clone_root}/src/${KNATIVE_EVENTING_SOURCES_REPO}"
clone_at_commit "https://${KNATIVE_EVENTING_SOURCES_REPO}.git" "${KNATIVE_EVENTING_SOURCES_COMMIT}" \
"${knative_eventing_sources_root}"
gen_refdocs "${refdocs_bin}" "${clone_root}" "${KNATIVE_EVENTING_SOURCES_OUT_FILE}" \
"${knative_eventing_sources_root}"
gen_refdocs "${refdocs_bin}" "${clone_root}" "${out_dir}" \
"${KNATIVE_EVENTING_SOURCES_OUT_FILE}" "${knative_eventing_sources_root}"

log "Generated files written to ${clone_root}/out/."
log "SUCCESS: Generated docs written to ${out_dir}/."
log "Copy the files in reference/ directory to knative/docs."
if command -v open >/dev/null; then
open "${clone_root}/out/"
elif command -v xdg-open >/dev/null; then
xdg-open "${clone_root}/out/"
if command -v xdg-open >/dev/null; then
xdg-open "${out_dir}/"
elif command -v open >/dev/null; then
open "${out_dir}/"
fi
}

Expand Down