Update version comments (#1271)

Author: deliahu

build/lint.sh

@@ -153,11 +153,12 @@ else
 
   # Check for version warning comments in examples
   output=$(cd "$ROOT/examples" && find . -type f \
-  ! -name "README.md" \
+  ! -path "./README.md" \
+  ! -path "./utils/*" \
   ! -name "*.json" \
   ! -name "*.txt" \
   ! -name ".*" \
-  -exec grep -L "WARNING: you are on the master branch, please refer to the examples on the branch that matches your \`cortex version\`" {} \;)
+  -exec grep -L "WARNING: you are on the master branch; please refer to examples on the branch corresponding to your \`cortex version\` (e\.g\. for version [0-9]*\.[0-9]*\.\*, run \`git checkout -b [0-9]*\.[0-9]*\` or switch to the \`[0-9]*\.[0-9]*\` branch on GitHub)" {} \;)
   if [[ $output ]]; then
     echo "example file(s) are missing version appropriate comment:"
     echo "$output"

dev/update_version_comments.sh

@@ -19,11 +19,50 @@ set -euo pipefail
 
 ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. >/dev/null && pwd)"
 
+arg1="${1:-""}"
+
 git_branch="${CIRCLE_BRANCH:-""}"
 if [ "$git_branch" = "" ]; then
   git_branch=$(cd "$ROOT" && git rev-parse --abbrev-ref HEAD)
 fi
 
+if [ -z "$git_branch" ]; then
+  echo "error: unable to determine git branch"
+  exit 1
+fi
+
+if [ "$git_branch" = "master" ]; then
+  if [ -z "$arg1" ]; then
+    echo "error: use \`./dev/update_version_comments.sh <minor_version>\` to update all docs and examples warnings"
+    exit 1
+  fi
+
+  if [[ "$OSTYPE" == "darwin"* ]]; then
+    cd "$ROOT" && find . -type f \
+    ! -path "./build/lint.sh" \
+    ! -path "./dev/update_version_comments.sh" \
+    ! -path "./vendor/*" \
+    ! -path "./bin/*" \
+    ! -path "./.git/*" \
+    ! -name ".*" \
+    -print0 | \
+    xargs -0 sed -i '' -e "s/WARNING: you are on the master branch; please refer to examples on the branch corresponding to your \`cortex version\` [(]e\.g\. for version [0-9]*\.[0-9]*\.\*, run \`git checkout -b [0-9]*\.[0-9]*\` or switch to the \`[0-9]*\.[0-9]*\` branch on GitHub[)]/WARNING: you are on the master branch; please refer to examples on the branch corresponding to your \`cortex version\` (e.g. for version ${arg1}.*, run \`git checkout -b ${arg1}\` or switch to the \`${arg1}\` branch on GitHub)/"
+  else
+    cd "$ROOT" && find . -type f \
+    ! -path "./build/lint.sh" \
+    ! -path "./dev/update_version_comments.sh" \
+    ! -path "./vendor/*" \
+    ! -path "./bin/*" \
+    ! -path "./.git/*" \
+    ! -name ".*" \
+    -print0 | \
+    xargs -0 sed -i "s/WARNING: you are on the master branch; please refer to examples on the branch corresponding to your \`cortex version\` [(]e\.g\. for version [0-9]*\.[0-9]*\.\*, run \`git checkout -b [0-9]*\.[0-9]*\` or switch to the \`[0-9]*\.[0-9]*\` branch on GitHub[)]/WARNING: you are on the master branch; please refer to examples on the branch corresponding to your \`cortex version\` (e.g. for version ${arg1}.*, run \`git checkout -b ${arg1}\` or switch to the \`${arg1}\` branch on GitHub)/"
+  fi
+
+  echo "done"
+  exit 0
+fi
+
 if ! echo "$git_branch" | grep -Eq ^[0-9]+.[0-9]+$; then
   echo "error: this is meant to be run on release branches"
   exit 1
@@ -60,7 +99,7 @@ if [[ "$OSTYPE" == "darwin"* ]]; then
   ! -path "./.git/*" \
   ! -name ".*" \
   -print0 | \
-  xargs -0 sed -i '' -e "s/WARNING: you are on the master branch, please refer to the examples on the branch that matches your \`cortex version\`/this is an example for cortex release ${git_branch} and may not deploy correctly on other releases of cortex/"
+  xargs -0 sed -i '' -e "s/WARNING: you are on the master branch; please refer to examples on the branch corresponding to your \`cortex version\` [(]e\.g\. for version [0-9]*\.[0-9]*\.\*, run \`git checkout -b [0-9]*\.[0-9]*\` or switch to the \`[0-9]*\.[0-9]*\` branch on GitHub[)]/this is an example for cortex release ${git_branch} and may not deploy correctly on other releases of cortex/"
 else
   cd "$ROOT" && find . -type f \
   ! -path "./build/lint.sh" \
@@ -70,7 +109,7 @@ else
   ! -path "./.git/*" \
   ! -name ".*" \
   -print0 | \
-  xargs -0 sed -i "s/WARNING: you are on the master branch, please refer to the examples on the branch that matches your \`cortex version\`/this is an example for cortex release ${git_branch} and may not deploy correctly on other releases of cortex/"
+  xargs -0 sed -i "s/WARNING: you are on the master branch; please refer to examples on the branch corresponding to your \`cortex version\` [(]e\.g\. for version [0-9]*\.[0-9]*\.\*, run \`git checkout -b [0-9]*\.[0-9]*\` or switch to the \`[0-9]*\.[0-9]*\` branch on GitHub[)]/this is an example for cortex release ${git_branch} and may not deploy correctly on other releases of cortex/"
 fi
 
 echo "done"

examples/apisplitter/README.md

@@ -1,6 +1,6 @@
 # Splitting traffic between APIs
 
-_WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`_
+_WARNING: you are on the master branch; please refer to examples on the branch corresponding to your `cortex version` (e.g. for version 0.18.*, run `git checkout -b 0.18` or switch to the `0.18` branch on GitHub)_
 
 This example shows how to split traffic between 2 different iris-classifiers deployed as SyncAPIs.
 

examples/apisplitter/cortex.yaml

@@ -1,4 +1,4 @@
-# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
+# WARNING: you are on the master branch; please refer to examples on the branch corresponding to your `cortex version` (e.g. for version 0.18.*, run `git checkout -b 0.18` or switch to the `0.18` branch on GitHub)
 
 - name: iris-classifier-onnx
   kind: SyncAPI

examples/apisplitter/onnx_predictor.py

@@ -1,4 +1,4 @@
-# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
+# WARNING: you are on the master branch; please refer to examples on the branch corresponding to your `cortex version` (e.g. for version 0.18.*, run `git checkout -b 0.18` or switch to the `0.18` branch on GitHub)
 
 labels = ["setosa", "versicolor", "virginica"]
 

examples/apisplitter/tensorflow_predictor.py

@@ -1,4 +1,4 @@
-# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
+# WARNING: you are on the master branch; please refer to examples on the branch corresponding to your `cortex version` (e.g. for version 0.18.*, run `git checkout -b 0.18` or switch to the `0.18` branch on GitHub)
 
 labels = ["setosa", "versicolor", "virginica"]
 

examples/batch/image-classifier/README.md

@@ -1,6 +1,6 @@
 # Deploy models as Batch APIs
 
-_WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`_
+_WARNING: you are on the master branch; please refer to examples on the branch corresponding to your `cortex version` (e.g. for version 0.18.*, run `git checkout -b 0.18` or switch to the `0.18` branch on GitHub)_
 
 This example shows how to deploy a batch image classification api that accepts a list of image urls as input, downloads the images, classifies them, and writes the results to S3.
 

examples/batch/image-classifier/cortex.yaml

@@ -1,4 +1,4 @@
-# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
+# WARNING: you are on the master branch; please refer to examples on the branch corresponding to your `cortex version` (e.g. for version 0.18.*, run `git checkout -b 0.18` or switch to the `0.18` branch on GitHub)
 
 - name: image-classifier
   kind: BatchAPI

examples/batch/image-classifier/predictor.py

@@ -1,4 +1,4 @@
-# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
+# WARNING: you are on the master branch; please refer to examples on the branch corresponding to your `cortex version` (e.g. for version 0.18.*, run `git checkout -b 0.18` or switch to the `0.18` branch on GitHub)
 
 import os
 import requests

examples/batch/onnx/README.md

@@ -1,6 +1,6 @@
 # Batch Image Classifier in ONNX
 
-You can deploy this example by cloning this repo with `git clone -b v<CORTEX_VERSION> https://github.com/cortexlabs/cortex`. The `<CORTEX_VERSION>` should be substituted with the version of your Cortex CLI. For example, if the output of `cortex version` is 0.18.1, the clone command would be `git clone -b v0.18.1 https://github.com/cortexlabs/cortex`. Then navigate to this example directory.
+_WARNING: you are on the master branch; please refer to examples on the branch corresponding to your `cortex version` (e.g. for version 0.18.*, run `git checkout -b 0.18` or switch to the `0.18` branch on GitHub)_
 
 <!-- CORTEX_VERSION_MINOR -->
 Please refer to the [tutorial](https://docs.cortex.dev/v/master/batchapi/image-classifier#deploy-your-batch-api) to see how to deploy a Batch API with Cortex.