From e4e66672143db37b6490adc7b61fa64d42ea34a5 Mon Sep 17 00:00:00 2001 From: Andreas Herrmann Date: Tue, 29 Oct 2024 15:32:43 +0100 Subject: [PATCH] Update the README and direnv configuration --- examples/persistent_worker/.envrc | 3 +++ examples/persistent_worker/README.md | 17 +++++++---------- 2 files changed, 10 insertions(+), 10 deletions(-) create mode 100644 examples/persistent_worker/.envrc diff --git a/examples/persistent_worker/.envrc b/examples/persistent_worker/.envrc new file mode 100644 index 000000000000..1ab1354014c7 --- /dev/null +++ b/examples/persistent_worker/.envrc @@ -0,0 +1,3 @@ +# specify the following: +# - BUILDBUDDY_API_KEY +source_env_if_exists .envrc.private diff --git a/examples/persistent_worker/README.md b/examples/persistent_worker/README.md index 0f88180c3cd3..8ab4f4c46db1 100644 --- a/examples/persistent_worker/README.md +++ b/examples/persistent_worker/README.md @@ -10,24 +10,21 @@ support for remote persistent workers to Buck2, see [#776]. ## Requirements -The demo uses Nix to provide required system dependencies, such as -Python and grpc-io. As well as direnv to set up the environment. +This demo uses BuildBuddy remote execution to demonstrate remote +persistent workers. You will need an API token for at least a free open +source account. You can use [direnv] to set up the environment: -- [Nix](https://nixos.org/) -- [direnv](https://direnv.net/) - -Credentials for [BuildBuddy](https://www.buildbuddy.io/) and -[GHCR](https://ghcr.io) stored in `.envrc.private`: +Credentials for [BuildBuddy] stored in `.envrc.private`: ``` export BUILDBUDDY_API_KEY=... -export BUILDBUDDY_CONTAINER_USER=... # GitHub user name -export BUILDBUDDY_CONTAINER_PASSWORD=... # GitHub access token -export GITHUB_USER=... # GitHub user name ``` Upload the Nix Docker image for remote execution as described in `platforms/buildbuddy.bzl`. +[direnv]: https://direnv.net/ +[BuildBuddy]: https://www.buildbuddy.io/ + ## Local Build Configure a local build without persistent workers: