From 8c3ca963218d3723d42a665993751b20ec67f81e Mon Sep 17 00:00:00 2001 From: Iain Dillingham Date: Mon, 2 Dec 2024 16:57:40 +0000 Subject: [PATCH 1/2] Fix typos --- README.md | 4 ++-- scripts/local-setup.sh | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 85a740cd..602ba899 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # bennettbot -bennettbot is a service for running jobs in reponse to Slack commands and GitHub webhooks. +bennettbot is a service for running jobs in response to Slack commands and GitHub webhooks. A job runs a bash command in a given directory. Jobs are organised by namespace, and are defined in `job_configs.py`. @@ -100,7 +100,7 @@ contents to slack. Jobs and commands can be parameterised. A slack command uses square brackets to indicate an expected parameter, which will be templated into the same named -paramter in `run_args_template`. +parameter in `run_args_template`. ``` raw_config = { diff --git a/scripts/local-setup.sh b/scripts/local-setup.sh index fa768234..117fbe5b 100755 --- a/scripts/local-setup.sh +++ b/scripts/local-setup.sh @@ -22,7 +22,7 @@ GCP_CREDENTIALS_PATH="$WRITEABLE_DIR/gcp-credentials.json" # ensure writeable_dir exists mkdir -p "$WRITEABLE_DIR" -# load ensure_values function +# load ensure_value function # shellcheck disable=SC1091 . "$BASE_DIR/scripts/lib.sh" From ea1777cad7f37ce82515af4613635016fd79c670 Mon Sep 17 00:00:00 2001 From: Iain Dillingham Date: Mon, 2 Dec 2024 16:58:18 +0000 Subject: [PATCH 2/2] Fix namespace name --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 602ba899..e9e47f4d 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ slack command ("say hello"), which schedules the "hello" job with a ``` raw_config = { - "example": { + "test": { "jobs": { "hello": { "run_args_template": "echo Hello", @@ -91,7 +91,7 @@ raw_config = { } } ``` -Call this with `@BennettBot example say hello`; after a 1 second delay, BennettBot +Call this with `@BennettBot test say hello`; after a 1 second delay, BennettBot will run `echo hello`, write the output to its log folder, and report the contents to slack.