Update releasing instructions

Author: adamcrume

RELEASING.md

@@ -36,7 +36,7 @@ Note that any crate not mentioned here (e.g. tensorflow-proto-codegen, tensorflo
    1. Bump the version for `tensorflow-internal-macros` in the root `Cargo.toml`
 1. Bump the version number in `Cargo.toml`
 1. Bump the version number in `README.md`
-1. Run `./test-all`
+1. Inside a virtualenv, run `./test-all`.  (See "Running in a virtualenv" section.)
 1. Double-check that addition.py is built using the version of TensorFlow being linked against.  (See "Upgrading TensorFlow" section.)
 1. Run `./run-valgrind`
 1. Commit and push the changes. (Push before publishing to ensure that the changes being published are up to date.)
@@ -56,13 +56,12 @@ Note that any crate not mentioned here (e.g. tensorflow-proto-codegen, tensorflo
 ## Upgrading TensorFlow
 
 1. Update version and tag in tensorflow-sys/build.rs
-1. Update version in run-valgrind
-1. Run `python examples/addition/addition.py` using the version of TensorFlow being linked against.
-   (Use pip in a virtualenv, see https://www.tensorflow.org/install/pip#2-create-a-virtual-environment-recommended)
-   1. Run `virtualenv --system-site-packages -p python3 ~/tensorflow-${TENSORFLOW_VERSION?}`
-   1. Run `source ~/tensorflow-${TENSORFLOW_VERSION?}/bin/activate` to activate the virtualenv
-   1. Run `pip install --upgrade pip`
-   1. Run `pip install --upgrade tensorflow==${TENSORFLOW_VERSION?}`
-   1. Run `pip install tf_keras` (required for examples/mobilenetv3)
-   1. Run `python examples/addition/addition.py`
-   1. Run `deactivate` to exit the virtualenv
+1. Update version in .github/workflow/requirements.txt
+1. Inside a virtualenv using the version of TensorFlow being linked against, run `python examples/addition/addition.py`.  (See "Running in a virtualenv" section.)
+
+## Running in a virtualenv
+
+1. If you haven't set it up, run `./create-virtualenv ${TENSORFLOW_VERSION?}`
+1. Run `source ~/tensorflow-${TENSORFLOW_VERSION?}/bin/activate` to activate the virtualenv
+1. Do whatever you need to do in the virtual env
+1. Run `deactivate` to exit the virtualenv

create-virtualenv

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+# See https://www.tensorflow.org/install/pip#2-create-a-virtual-environment-recommended
+
+set -euo pipefail
+
+if [ "$#" -lt 1 ]; then
+     echo "Expected first argument to be TensorFlow version"
+     exit 1
+fi
+TENSORFLOW_VERSION="$1"
+
+function run {
+    echo "----------------------------------------------------------------------"
+    echo "Running: $@"
+    "$@"
+    echo
+}
+
+run virtualenv --system-site-packages -p python3 ~/tensorflow-${TENSORFLOW_VERSION?}
+run source ~/tensorflow-${TENSORFLOW_VERSION?}/bin/activate
+run pip install --upgrade pip
+run pip install --upgrade tensorflow==${TENSORFLOW_VERSION?}
+run pip install tf_keras # required for examples/mobilenetv3
+run deactivate

run-valgrind

@@ -19,8 +19,6 @@ function run {
     echo
 }
 
-tensorflow_version=2.16.1
-
 valgrind_log=valgrind.log
 truncate --size=0 "$valgrind_log"
 

test-all

@@ -12,14 +12,11 @@ function run {
 # Make sure the Tensorflow version in the -sys build script matches the one in
 # the run-valgrind script.
 version_build_script=`grep "const VERSION" tensorflow-sys/build.rs | sed 's|.*"\([^"]*\)";|\1|g'`
-version_run_valgrind=`grep "tensorflow_version=" run-valgrind | sed "s|.*=\(.*\)|\1|g"`
 version_requirements=`grep "tensorflow\s*=" .github/workflows/requirements.txt | sed "s|.*== \(.*\)|\1|g"`
-if [[ "${version_build_script}" != "${version_run_valgrind}" || \
-    "${version_build_script}" != "${version_requirements}" ]]; then
-    echo "ERROR: Tensorflow version specified in build script does not match the one in the"
-    echo "       valgrind run script."
+if [[ "${version_build_script}" != "${version_requirements}" ]]; then
+    echo "ERROR: TensorFlow version specified in build script does not match the one in the"
+    echo "       GitHub requirements."
     echo "       tensorflow-sys/build.rs: ${version_build_script}"
-    echo "       run-valgrind: ${version_run_valgrind}"
     echo "       .github/workflows/requirements.txt: ${version_requirements}"
     exit 1
 fi