Skip to content

Commit fcc2ebe

Browse files
Fiona NeillDavis Bickford
andcommitted
Merge branch 'update-docs-to-go-install' into 'main'
Update instructions to suggest go install rather than go build for building plugins See merge request https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3819 Merged-by: Fiona Neill <[email protected]> Approved-by: Joe Burnett <[email protected]> Approved-by: Fiona Neill <[email protected]> Co-authored-by: Davis Bickford <[email protected]>
2 parents 9dd990b + c3ba3bf commit fcc2ebe

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/development/index.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,8 +189,22 @@ The canonical build and configuration instructions will live with each plugin, b
189189

190190
#### Build the plugin
191191

192-
Each plugin can be built with `go build -o <plugin-name> ./cmd/`.
193-
The resulting binary should be placed somewhere on the local `$PATH`.
192+
To run GitLab Runner with a plugin, generate an executable binary and place it on your system's `PATH`.
193+
194+
To generate the binary, ensure `$GOPATH/bin` is on your `PATH`, then use `go install`.
195+
196+
Each plugin contains a path to `./cmd/<plugin-name>`. For example, from the `fleeting-plugin-aws` directory:
197+
198+
```shell
199+
cd cmd/fleeting-plugin-aws/
200+
go install
201+
```
202+
203+
If you manage go versions with asdf, run this command after the binary generates:
204+
205+
```shell
206+
asdf reshim
207+
```
194208

195209
#### Use the plugin
196210

0 commit comments

Comments
 (0)