From f73ad0e3aa9f4b58da27fe764095c03fb36a628d Mon Sep 17 00:00:00 2001 From: Keith Duncan Date: Tue, 21 Sep 2021 13:49:35 +1000 Subject: [PATCH 1/2] Update readme installation instructions for release assets --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c00116..4b34b70 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,10 @@ Different types of secrets are supported and exposed to your builds in appropria The hooks needs to be installed directly in the agent so that secrets can be downloaded before jobs attempt checking out your repository. We are going to assume that buildkite has been installed at `/buildkite`, but this will vary depending on your operating system. Change the instructions accordingly. -The core of the hook is an `s3secrets-helper` binary, the result of `go build` in the `s3secrets-helper/` subdirectory of this repository. It must be placed in `$PATH` to be found by the `hooks/environment` wrapper script. +The core of the hook is an `s3secrets-helper` binary. This can be built using +`go build` in the [`s3secrets-helper/`](s3secrets-helper) directory in this +repository, or downloaded from the assets attached to the [GitHub Release](https://github.com/buildkite/elastic-ci-stack-s3-secrets-hooks/releases). +It must be placed in `$PATH` to be found by the `hooks/environment` wrapper script. ```bash # clone to a path your buildkite-agent can access @@ -20,7 +23,7 @@ git clone https://github.com/buildkite-plugins/s3-secrets-buildkite-plugin.git / (cd /buildkite/s3_secrets/s3secrets-helper && go build -o /usr/local/bin/s3secrets-helper) ``` -Modify your agent's global hooks (see [https://buildkite.com/docs/agent/v3/hooks#global-hooks](https://buildkite.com/docs/agent/v3/hooks#global-hooks)): +Modify your agent's hooks (see [Hook Locations](https://buildkite.com/docs/agent/v3/hooks#hook-locations): ### `${BUILDKITE_ROOT}/hooks/environment` From bc38e4b2ec9a981f5307ebdf21db49412fc9b584 Mon Sep 17 00:00:00 2001 From: Keith Duncan Date: Tue, 21 Sep 2021 13:50:12 +1000 Subject: [PATCH 2/2] s/the/a --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b34b70..e781c35 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ The hooks needs to be installed directly in the agent so that secrets can be dow The core of the hook is an `s3secrets-helper` binary. This can be built using `go build` in the [`s3secrets-helper/`](s3secrets-helper) directory in this -repository, or downloaded from the assets attached to the [GitHub Release](https://github.com/buildkite/elastic-ci-stack-s3-secrets-hooks/releases). +repository, or downloaded from the assets attached to a [GitHub Release](https://github.com/buildkite/elastic-ci-stack-s3-secrets-hooks/releases). It must be placed in `$PATH` to be found by the `hooks/environment` wrapper script. ```bash