Skip to content

Commit 04df5f3

Browse files
authored
Merge pull request #50 from buildkite/keithduncan/document-release-assets
Update readme installation instructions for release assets
2 parents 5154931 + bc38e4b commit 04df5f3

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,18 @@ Different types of secrets are supported and exposed to your builds in appropria
1212

1313
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.
1414

15-
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.
15+
The core of the hook is an `s3secrets-helper` binary. This can be built using
16+
`go build` in the [`s3secrets-helper/`](s3secrets-helper) directory in this
17+
repository, or downloaded from the assets attached to a [GitHub Release](https://github.com/buildkite/elastic-ci-stack-s3-secrets-hooks/releases).
18+
It must be placed in `$PATH` to be found by the `hooks/environment` wrapper script.
1619

1720
```bash
1821
# clone to a path your buildkite-agent can access
1922
git clone https://github.com/buildkite-plugins/s3-secrets-buildkite-plugin.git /buildkite/s3_secrets
2023
(cd /buildkite/s3_secrets/s3secrets-helper && go build -o /usr/local/bin/s3secrets-helper)
2124
```
2225

23-
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)):
26+
Modify your agent's hooks (see [Hook Locations](https://buildkite.com/docs/agent/v3/hooks#hook-locations):
2427

2528
### `${BUILDKITE_ROOT}/hooks/environment`
2629

0 commit comments

Comments
 (0)