mirror of
https://github.com/hanzo-ml/trainer.git
synced 2026-09-24 00:31:34 +00:00
Tariq HasanandGitHub
9183dfd24f
* chore(scripts): add copyright boilerplate verification system Signed-off-by: tariq-hasan <[email protected]> * chore(ci): add boilerplate verification to CI pipeline Signed-off-by: tariq-hasan <[email protected]> * chore: regenerate files with year-less copyright headers Signed-off-by: tariq-hasan <[email protected]> * refactor(boilerplate): simplify verification logic Signed-off-by: tariq-hasan <[email protected]> * chore(boilerplate): add missing copyright headers Signed-off-by: tariq-hasan <[email protected]> * ci(boilerplate): move verifier to code-quality workflow and run unit tests Signed-off-by: tariq-hasan <[email protected]> * feat(boilerplate): accept license headers with any year and remove year validation logic Signed-off-by: tariq-hasan <[email protected]> * feat(boilerplate): add copyright headers to generated Python API Signed-off-by: tariq-hasan <[email protected]> * refactor(boilerplate): use block-comment header for generated Go files Signed-off-by: tariq-hasan <[email protected]> * feat(boilerplate): verify copyright headers in Rust files Signed-off-by: tariq-hasan <[email protected]> --------- Signed-off-by: tariq-hasan <[email protected]>
82 lines
2.9 KiB
Bash
Executable File
82 lines
2.9 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# Copyright 2025 The Kubeflow 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.
|
|
|
|
# Run this script from the root location: `make generate`
|
|
|
|
set -o errexit
|
|
set -o nounset
|
|
|
|
# Source container runtime utilities
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
source "${SCRIPT_DIR}/../scripts/container-runtime.sh"
|
|
|
|
# Setup container runtime
|
|
setup_container_runtime
|
|
|
|
TRAINER_ROOT="$(pwd)"
|
|
|
|
VERSION_FILE="${TRAINER_ROOT}/VERSION"
|
|
if [ ! -f "${VERSION_FILE}" ]; then
|
|
echo "Missing VERSION file at ${VERSION_FILE}"
|
|
exit 1
|
|
fi
|
|
API_VERSION=$(sed -e 's/^v//' -e 's/-rc\.\([0-9]*\)/rc\1/' "${VERSION_FILE}")
|
|
API_OUTPUT_PATH="api/python_api"
|
|
PKG_ROOT="${API_OUTPUT_PATH}/kubeflow_trainer_api"
|
|
|
|
OPENAPI_GENERATOR_VERSION="v7.13.0"
|
|
SWAGGER_CODEGEN_CONF="hack/python-api/swagger_config.json"
|
|
SWAGGER_CODEGEN_FILE="api/openapi-spec/swagger.json"
|
|
|
|
echo "Generating Python API models for Kubeflow Trainer V2 using ${CONTAINER_RUNTIME}..."
|
|
# We need to add user to allow container override existing files.
|
|
${CONTAINER_RUNTIME} run --user "$(id -u)":"$(id -g)" --rm \
|
|
-v "${TRAINER_ROOT}:/local" docker.io/openapitools/openapi-generator-cli:${OPENAPI_GENERATOR_VERSION} generate \
|
|
-g python \
|
|
-i "local/${SWAGGER_CODEGEN_FILE}" \
|
|
-c "local/${SWAGGER_CODEGEN_CONF}" \
|
|
-o "local/${API_OUTPUT_PATH}" \
|
|
-p=packageVersion="${API_VERSION}" \
|
|
--global-property models,modelTests=false,modelDocs=false,supportingFiles=__init__.py
|
|
|
|
echo "Removing unused files for the Python API"
|
|
git clean -f ${API_OUTPUT_PATH}/.openapi-generator
|
|
git clean -f ${API_OUTPUT_PATH}/.github
|
|
git clean -f ${API_OUTPUT_PATH}/test
|
|
git clean -f ${PKG_ROOT}/api
|
|
|
|
# Revert manually created files.
|
|
git checkout ${PKG_ROOT}/__init__.py
|
|
|
|
# Manually modify the SDK version in the __init__.py file.
|
|
if [[ $(uname) == "Darwin" ]]; then
|
|
sed -i '' -e "s/__version__.*/__version__ = \"${API_VERSION}\"/" ${PKG_ROOT}/__init__.py
|
|
else
|
|
sed -i -e "s/__version__.*/__version__ = \"${API_VERSION}\"/" ${PKG_ROOT}/__init__.py
|
|
fi
|
|
|
|
echo "Adding copyright headers to generated Python API models"
|
|
BOILERPLATE="${TRAINER_ROOT}/hack/boilerplate/boilerplate.sh.txt"
|
|
find "${PKG_ROOT}/models" "${PKG_ROOT}/__init__.py" -name '*.py' -type f | while read -r f; do
|
|
if ! head -n 5 "$f" | grep -q "Copyright"; then
|
|
tmp="$(mktemp)"
|
|
cat "${BOILERPLATE}" > "$tmp"
|
|
echo "" >> "$tmp"
|
|
cat "$f" >> "$tmp"
|
|
mv "$tmp" "$f"
|
|
fi
|
|
done
|