Skip to content

Commit

Permalink
add docs on br source
Browse files Browse the repository at this point in the history
  • Loading branch information
qu1queee committed Oct 18, 2023
1 parent 416c26a commit 5aa6e61
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/buildrun.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,27 @@ spec:
image: foo/bar:latest
```

### Defining the Build Source

BuildRun's support the specification of a Local type source. This is useful for working on development
mode, without forcing a user to commit/push changes to their related version control system. For more information please
refer to [SHIP 0016 - enabling local source code](https://github.com/shipwright-io/community/blob/main/ships/0016-enable-local-source-code-support.md).

```yaml
apiVersion: shipwright.io/v1beta1
kind: BuildRun
metadata:
name: local-buildrun
spec:
build:
name: a-build
source:
type: Local
local:
name: local-source
timeout: 3m
```

### Defining ParamValues

A `BuildRun` resource can define _paramValues_ for parameters specified in the build strategy. If a value has been provided for a parameter with the same name in the `Build` already, then the value from the `BuildRun` will have precedence.
Expand Down

0 comments on commit 5aa6e61

Please sign in to comment.