Updated runner and shim contributing guide #2534 (use env vars)

Author: peterschmidt85

.gitignore

@@ -20,5 +20,6 @@ build/
 .DS_Store
 .fleet
 .env
+.envrc
 .aider*
 uv.lock

runner/.justfile

@@ -2,7 +2,9 @@
 #
 # Run `just` to see all available commands
 #
-# IMPORTANT: Change the s3_bucket and version variables below before running any commands.
+# Configuration:
+# - DSTACK_SHIM_UPLOAD_VERSION: Version of the runner and shim to upload
+# - DSTACK_SHIM_UPLOAD_S3_BUCKET: S3 bucket to upload binaries to
 #
 # Build Process:
 # - Runner is always built for linux/amd64
@@ -23,12 +25,11 @@
 default:
     @just --list
 
-# Export version variable
-# Must be changed to a unique value to avoid conflicts with other developers using the same bucket
-export version := "0.0.0"
+# Version of the runner and shim to upload
+export version := env_var("DSTACK_SHIM_UPLOAD_VERSION")
 
-# S3 bucket name - must be set to a bucket that the developer has access to
-export s3_bucket := "dstack-runner-downloads-stgn"
+# S3 bucket to upload binaries to
+export s3_bucket := env_var("DSTACK_SHIM_UPLOAD_S3_BUCKET")
 
 # Download URLs
 export runner_download_url := "s3://" + s3_bucket + "/" + version + "/binaries/dstack-runner-linux-amd64"

runner/README.md

@@ -88,19 +88,24 @@ You can also test the built shim and runner using standard backends (including S
 Build the runner and shim, and upload them to S3 automatically using `just` (see [`justfile`](justfile)).
 
 > [!IMPORTANT]
-> Before running any `just` commands that upload to S3, make sure to modify the `s3_bucket` and `version` 
-> variables in the [`justfile`](justfile).
+> Before running any `just` commands that upload to S3, you must set the following environment variables:
+>
+> ```shell
+> export DSTACK_SHIM_UPLOAD_VERSION="your-version"
+> export DSTACK_SHIM_UPLOAD_S3_BUCKET="your-bucket"
+> ```
+>
+> These variables are required and must be set before running any upload commands.
 
 ```shell
 just upload
 ```
 
-To use the built shim and runner with the dstack server, pass the URLs via `DSTACK_SHIM_DOWNLOAD_URL` and `DSTACK_RUNNER_DOWNLOAD_URL`. Make sure to use the same `s3_bucket` and `version` values that you set in the [`justfile`](justfile).
+To use the built shim and runner with the dstack server, pass the URLs via `DSTACK_SHIM_DOWNLOAD_URL` and `DSTACK_RUNNER_DOWNLOAD_URL`:
 
 ```shell
-DSTACK_SHIM_DOWNLOAD_URL=https://<s3_bucket>.s3.<s3_bucket_region>.amazonaws.com/<version>/binaries/dstack-shim-linux-amd64
-
-DSTACK_RUNNER_DOWNLOAD_URL=https://<s3_bucket>.s3.<s3_bucket_region>.amazonaws.com/<version>/binaries/dstack-runner-linux-amd64
+export DSTACK_SHIM_DOWNLOAD_URL="https://${DSTACK_SHIM_UPLOAD_S3_BUCKET}.s3.amazonaws.com/${DSTACK_SHIM_UPLOAD_VERSION}/binaries/dstack-shim-linux-amd64"
+export DSTACK_RUNNER_DOWNLOAD_URL="https://${DSTACK_SHIM_UPLOAD_S3_BUCKET}.s3.amazonaws.com/${DSTACK_SHIM_UPLOAD_VERSION}/binaries/dstack-runner-linux-amd64"
 
 dstack server --log-level=debug
 ```