updated readmes and versions

aws · Nov 16, 2020 · 8b4a94f · 8b4a94f
1 parent 3e7b023
commit 8b4a94f
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 11 deletions.
diff --git a/examples/deadline/All-In-AWS-Infrastructure-SEP/python/README.md b/examples/deadline/All-In-AWS-Infrastructure-SEP/python/README.md
@@ -18,6 +18,20 @@ These instructions assume that your working directory is `examples/deadline/All-
     ```bash
     pip install -r requirements.txt
     ```
+3.  If working on the `release` branch, this step can be skipped. If working on `mainline`, navigate to the base directory where the build and packaging scripts are, then run them and install the result over top of the `aws-rfdk` version that was installed in the previous step:
+    ```bash
+    # Navigate to the root directory of the RFDK repository
+    pushd ../../../..
+    # Enter the Docker container to run the build and pack scripts
+    ./scripts/rfdk_build_environment.sh
+    ./build.sh
+    ./pack.sh
+    # Exit the Docker container
+    exit
+    # Navigate back to the example directory
+    popd
+    pip install ../../../../dist/python/aws-rfdk-<version>.tar.gz
+    ```
 3. Stage the Docker recipes for `RenderQueue`:
 
     ```bash

diff --git a/examples/deadline/All-In-AWS-Infrastructure-SEP/python/setup.py b/examples/deadline/All-In-AWS-Infrastructure-SEP/python/setup.py
@@ -17,8 +17,8 @@
     packages=setuptools.find_packages(where="package"),
 
     install_requires=[
-        "aws-cdk.core==1.70.0",
-        "aws-rfdk==0.19.0"
+        "aws-cdk.core==1.72.0",
+        "aws-rfdk==0.20.0"
     ],
 
     python_requires=">=3.7",

diff --git a/examples/deadline/All-In-AWS-Infrastructure-SEP/ts/README.md b/examples/deadline/All-In-AWS-Infrastructure-SEP/ts/README.md
@@ -1,4 +1,4 @@
-# RFDK Sample Application - Deadline - Typescript
+# RFDK Sample Application - Deadline Spot Event Plugin - Typescript
 
 ## Overview
 [Back to overview](../README.md)
@@ -11,7 +11,7 @@
 These instructions assume that your working directory is `examples/deadline/All-In-AWS-Infrastructure-SEP/ts/` relative to the root of the RFDK package.
 
 ---
-1. This sample app on the mainline branch may contain features that have not yet been officially released, and may not be available in the aws-rfdk package installed through npm from npmjs. To work from an example of the latest release, please switch to the release branch. If you would like to try out unreleased features, you can stay on mainline and follow the instructions for building, packing, and installing the aws-rfdk from your local repository.
+1. This sample app on the `mainline` branch may contain features that have not yet been officially released, and may not be available in the `aws-rfdk` package installed through npm from npmjs. To work from an example of the latest release, please switch to the `release` branch. If you would like to try out unreleased features, you can stay on `mainline` and follow the instructions for building and using the `aws-rfdk` from your local repository.
 2. Install the dependencies of the sample app:
 
     ```
@@ -22,9 +22,17 @@ These instructions assume that your working directory is `examples/deadline/All-
     ```
     yarn stage
     ```
-4. Build the sample app:
-
-    ```
+4. Build the `aws-rfdk` package, and then build the sample app. There is some magic in the way yarn workspaces and lerna packages work that will link the built `aws-rfdk` from the base directory as the dependency to be used in the example's directory:
+    ```bash
+    # Navigate to the root directory of the RFDK repository (assumes you started in the example's directory)
+    pushd ../../../..
+    # Enter the Docker container, run the build, and then exit
+    ./scripts/rfdk_build_environment.sh
+    ./build.sh
+    exit
+    # Navigate back to the example directory
+    popd
+    # Run the example's build
     yarn build
     ```
 5. Deploy all the stacks in the sample app:

diff --git a/examples/deadline/All-In-AWS-Infrastructure-SEP/ts/package.json b/examples/deadline/All-In-AWS-Infrastructure-SEP/ts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "all-in-farm-sep",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "bin": {
     "app": "bin/app.js"
   },
@@ -19,13 +19,13 @@
   },
   "devDependencies": {
     "@types/node": "^14.6.1",
-    "aws-cdk": "1.70.0",
+    "aws-cdk": "1.72.0",
     "ts-node": "^9.0.0",
     "typescript": "~3.9.7"
   },
   "dependencies": {
-    "@aws-cdk/core": "1.70.0",
-    "aws-rfdk": "0.19.0",
+    "@aws-cdk/core": "1.72.0",
+    "aws-rfdk": "0.20.0",
     "source-map-support": "^0.5.19"
   }
 }