ray-project
diff --git a/‎.buildkite/setup-env.sh
Lines changed: 1 addition & 0 deletions b/‎.buildkite/setup-env.sh
Lines changed: 1 addition & 0 deletions
diff --git a/‎.github/workflows/test-job.yaml
Lines changed: 0 additions & 12 deletions b/‎.github/workflows/test-job.yaml
Lines changed: 0 additions & 12 deletions
diff --git a/‎.gitignore
Lines changed: 3 additions & 0 deletions b/‎.gitignore
Lines changed: 3 additions & 0 deletions
diff --git a/‎.golangci.yml
Lines changed: 0 additions & 7 deletions b/‎.golangci.yml
Lines changed: 0 additions & 7 deletions
diff --git a/‎.pre-commit-config.yaml
Lines changed: 31 additions & 33 deletions b/‎.pre-commit-config.yaml
Lines changed: 31 additions & 33 deletions
diff --git a/‎CHANGELOG.md
Lines changed: 1 addition & 1 deletion b/‎CHANGELOG.md
Lines changed: 1 addition & 1 deletion
diff --git a/‎apiserver/hack/update-swagger-ui.bash
Lines changed: 6 additions & 5 deletions b/‎apiserver/hack/update-swagger-ui.bash
Lines changed: 6 additions & 5 deletions
diff --git a/‎ci/markdownlint.yaml
Lines changed: 21 additions & 0 deletions b/‎ci/markdownlint.yaml
Lines changed: 21 additions & 0 deletions
diff --git a/‎clients/python-client/README.md
Lines changed: 2 additions & 2 deletions b/‎clients/python-client/README.md
Lines changed: 2 additions & 2 deletions
diff --git a/‎docs/development/development.md
Lines changed: 19 additions & 0 deletions b/‎docs/development/development.md
Lines changed: 19 additions & 0 deletions
@@ -35,6 +35,7 @@ python3 -m venv .venv
 # Activate the virtual environment and then execute the subsequent commands
 # within the same sub-shell.
 (
+    # shellcheck disable=SC1091  # Ignore: activate script is created by venv
     source .venv/bin/activate
 
     # Install requirements
 
@@ -12,18 +12,6 @@ jobs:
     name: Lint (pre-commit)
     runs-on: ubuntu-22.04
     steps:
-      - name: Install golangci-lint
-        run: |
-          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.60.3
-          mv ./bin/golangci-lint /usr/local/bin/golangci-lint
-        shell: bash
-
-      - name: Install kubeconform
-        run: |
-          curl -L https://github.com/yannh/kubeconform/releases/download/v0.6.7/kubeconform-linux-amd64.tar.gz -o kubeconform.tar.gz
-          tar -xzf kubeconform.tar.gz
-          mv kubeconform /usr/local/bin/
-
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v3
       - uses: pre-commit/[email protected]
 
@@ -50,3 +50,6 @@
 
 # Any file with a .log extension
 **/*.log
+
+# Ignore generated CRD schema files
+schema/
@@ -58,14 +58,7 @@ linters-settings:
   # TODO: Enable all testifylint rules
   testifylint:
     disable:
-      - formatter
-      - float-compare
-      - require-error
-      - expected-actual
-      - bool-compare
-      - len
       - compares
-      - empty
 linters:
   enable:
     - asciicheck
 
@@ -27,50 +27,48 @@ repos:
     hooks:
       - id: gitleaks
 
-  - repo: local
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
     hooks:
-      - id: check-golangci-lint-version
-        name: golangci-lint version check
-        entry: bash -c 'version="1.60.3"; [ "$(golangci-lint --version | awk "/version/ {print \$4}" | sed "s/^v//")" = "$version" ] || { echo "golangci-lint version is not $version"; exit 1; }'
-        language: system
-        always_run: true
-        fail_fast: true
-        pass_filenames: false
+      - id: shellcheck
 
   - repo: local
     hooks:
-      - id: golangci-lint-ray-operator
-        name: golangci-lint (ray-operator)
-        entry: bash -c 'cd ray-operator && golangci-lint run --fix --exclude-files _generated.go --timeout 10m0s; status=$?; cd ..; exit $status'
+      - id: golangci-lint
+        name: golangci-lint
+        entry: ./scripts/lint.sh
         types: [ go ]
         language: golang
         require_serial: true
-        files: ^ray-operator/
-
-  - repo: local
-    hooks:
-      - id: golangci-lint-kubectl-plugin
-        name: golangci-lint (kubectl-plugin)
-        entry: bash -c 'cd kubectl-plugin && golangci-lint run --fix --timeout 10m0s; status=$?; cd ..; exit $status'
-        types: [ go ]
-        language: golang
+        always_run: true
+        pass_filenames: false
+        additional_dependencies:
+          - github.com/golangci/golangci-lint/cmd/[email protected]
+      - id: generate-crd-schema
+        name: generate CRD schemas for use of kubeconform
+        entry: ./scripts/generate-crd-schema.sh
+        language: python
         require_serial: true
-        files: ^kubectl-plugin/
-
-  - repo: local
-    hooks:
-      - id: check-kubeconform-version
-        name: kubeconform version check
-        entry: bash -c 'version="0.6.7"; [ "$(kubeconform -v | awk -F"v" "{print \$2}")" = "$version" ] || { echo "kubeconform version is not $version"; exit 1; }'
-        language: system
         always_run: true
-        fail_fast: true
         pass_filenames: false
-
-  - repo: local
-    hooks:
+        additional_dependencies:
+          - PyYAML==6.0.1
       - id: validate-helm-charts
         name: validate helm charts with kubeconform
         entry: bash scripts/validate-helm.sh
-        language: system
+        language: golang
+        require_serial: true
+        always_run: true
         pass_filenames: false
+        additional_dependencies:
+          - github.com/yannh/kubeconform/cmd/[email protected]
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.44.0
+    hooks:
+      - id: markdownlint
+        name: Markdown linting
+        args:
+          - --config
+          - ci/markdownlint.yaml
+          - --fix
@@ -417,7 +417,7 @@ The following individuals contributed to KubeRay 0.5.0. This list is alphabetica
 * [Feature][Hotfix] Add observedGeneration to the status of CRDs ([#979](https://github.com/ray-project/kuberay/pull/979), @kevin85421)
 * Customize the Prometheus export port ([#954](https://github.com/ray-project/kuberay/pull/954), @Yicheng-Lu-llll)
 * [Feature] The default ImagePullPolicy should be IfNotPresent ([#947](https://github.com/ray-project/kuberay/pull/947), @kevin85421)
-*  Inject the --block option to ray start command automatically ([#932](https://github.com/ray-project/kuberay/pull/932), @Yicheng-Lu-llll)
+* Inject the --block option to ray start command automatically ([#932](https://github.com/ray-project/kuberay/pull/932), @Yicheng-Lu-llll)
 * Inject cluster name as an environment variable into head and worker pods ([#934](https://github.com/ray-project/kuberay/pull/934), @Yicheng-Lu-llll)
 * Ensure container ports without names are also included in the head node service ([#891](https://github.com/ray-project/kuberay/pull/891), @Yicheng-Lu-llll)
 * fix: `.status.availableWorkerReplicas` ([#887](https://github.com/ray-project/kuberay/pull/887), @davidxia)
 
@@ -1,19 +1,20 @@
 #!/bin/bash
 set -e
 set -x
-readonly REPO_ROOT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )"/../.. &> /dev/null && pwd)
+REPO_ROOT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )"/../.. &> /dev/null && pwd)
+readonly REPO_ROOT_DIR
 readonly TARGET_DIR="${REPO_ROOT_DIR}/third_party/swagger-ui"
 readonly SWAGGER_UI_VERSION=${1:-"5.4.1"}
 readonly SWAGGER_UI_TAR_URL="https://github.com/swagger-api/swagger-ui/archive/refs/tags/v${SWAGGER_UI_VERSION}.tar.gz"
 
-if [ -f ${TARGET_DIR}/swagger-initializer.js ];then
-    cp -v ${TARGET_DIR}/swagger-initializer.js ${TARGET_DIR}/swagger-initializer.js.backup
+if [ -f "${TARGET_DIR}"/swagger-initializer.js ];then
+    cp -v "${TARGET_DIR}"/swagger-initializer.js "${TARGET_DIR}"/swagger-initializer.js.backup
 fi
 echo "Downloading '${SWAGGER_UI_TAR_URL}' to update ${TARGET_DIR}"
 tmp="$(mktemp -d)"
 #pushd .
-curl --output-dir ${tmp} --fail --silent --location --remote-header-name --remote-name ${SWAGGER_UI_TAR_URL}
-tar -xzvf ${tmp}/swagger-ui-${SWAGGER_UI_VERSION}.tar.gz -C ${tmp}
+curl --output-dir "${tmp}" --fail --silent --location --remote-header-name --remote-name "${SWAGGER_UI_TAR_URL}"
+tar -xzvf "${tmp}"/swagger-ui-"${SWAGGER_UI_VERSION}".tar.gz -C "${tmp}"
 #popd
 cp -rv "$tmp/swagger-ui-${SWAGGER_UI_VERSION}/dist/"* "${TARGET_DIR}"
 rm -rf "$tmp"
@@ -0,0 +1,21 @@
+---
+# Default state for all rules
+default: true
+
+MD005: false
+MD007: false
+MD012: false
+MD013: false
+MD022: false
+MD024: false
+MD025: false
+MD026: false
+MD031: false
+MD032: false
+MD033: false
+MD034: false
+MD036: false
+MD040: false
+MD041: false
+MD050: false
+MD052: false
@@ -103,13 +103,13 @@ make sure you have installed setuptool
 
 `pip install -U pip setuptools`
 
-#### run the pip command
+### run the pip command
 
 from the directory `path/to/kuberay/clients/python-client`
 
 `pip install -e .`
 
-#### to uninstall the module run
+### to uninstall the module run
 
 `pip uninstall python-client`
 
 
@@ -3,6 +3,13 @@
 This guide provides an overview of the different components in the KubeRay project and instructions for developing and testing each component.
 Most developers will be concerned with the KubeRay Operator; the other components are optional.
 
+## Pre-commit Hooks
+
+We use [pre-commit] to lint and format code before each commit.
+
+1. Install [pre-commit]
+1. Run `pre-commit install` to install the pre-commit hooks
+
 ## KubeRay Operator
 
 The KubeRay Operator is responsible for managing Ray clusters on Kubernetes.
@@ -14,13 +21,21 @@ The KubeRay APIServer is a central component that exposes the KubeRay API for ma
 For more information about developing and testing the KubeRay APIServer, please refer to the [APIServer Development Guide](https://github.com/ray-project/kuberay/blob/master/apiserver/DEVELOPMENT.md).
 
 ## KubeRay Python client
+
 The KubeRay Python client library provides APIs to handle RayCluster from your Python application. For more information about developing and testing the KubeRay Python client, please refer to the [Python Client](https://github.com/ray-project/kuberay/blob/master/components/pythonclient.md), [Python API Client](https://github.com/ray-project/kuberay/blob/master/components/pythonapiclient.md).
 
 ## Proto and OpenAPI
 
 KubeRay uses Protocol Buffers (protobuf) and OpenAPI specifications to define the API and data structures.
 For more information about developing and testing proto files and OpenAPI specifications, please refer to the [Proto and OpenAPI Development Guide](https://github.com/ray-project/kuberay/blob/master/proto/README.md).
 
+## KubeRay Kubectl Plugin (beta)
+
+A [kubectl plugin] that simplifies common workflows when deploying Ray on Kubernetes. If
+you aren't familiar with Kubernetes, this plugin simplifies running Ray on Kubernetes.
+For more information about developing and testing the KubeRay Kubectl Plugin, please refer to the
+[Kubectl Plugin Development Guide].
+
 ## Deploying Documentation Locally
 
 To preview the KubeRay documentation locally, follow these steps:
@@ -36,3 +51,7 @@ docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
 - Open your web browser and navigate to <http://127.0.0.1:8000/kuberay/> to view the documentation.
 
 If you make any changes to the documentation files, the local preview will automatically update to reflect those changes.
+
+[pre-commit]: https://pre-commit.com/
+[kubectl plugin]: https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/
+[Kubectl Plugin Development Guide]: ../../kubectl-plugin/DEVELOPMENT.md
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ python3 -m venv .venv`
`35`	`35`	`# Activate the virtual environment and then execute the subsequent commands`
`36`	`36`	`# within the same sub-shell.`
`37`	`37`	`(`
	`38`	`+ # shellcheck disable=SC1091 # Ignore: activate script is created by venv`
`38`	`39`	`source .venv/bin/activate`
`39`	`40`
`40`	`41`	`# Install requirements`