Skip to content

Commit c861a0e

Browse files
committed
Update readme for upcoming release
1 parent 9e85356 commit c861a0e

1 file changed

Lines changed: 13 additions & 14 deletions

File tree

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ For example, in the following configuration:
4545
steps:
4646
- label: "Triggering pipelines"
4747
plugins:
48-
- monorepo-diff#v1.5.1:
48+
- monorepo-diff#v1.5.2:
4949
diff: "git diff --name-only HEAD~1"
5050
watch:
5151
- path: "**/*"
@@ -78,7 +78,7 @@ This is a sub-section that provides configuration for running commands or trigge
7878
steps:
7979
- label: "Triggering pipelines"
8080
plugins:
81-
- monorepo-diff#v1.5.1:
81+
- monorepo-diff#v1.5.2:
8282
watch:
8383
- path: app/
8484
config:
@@ -109,7 +109,7 @@ steps:
109109
steps:
110110
- label: "Triggering pipelines with plugin"
111111
plugins:
112-
- monorepo-diff#v1.5.1:
112+
- monorepo-diff#v1.5.2:
113113
watch:
114114
- path: test/.buildkite/
115115
config: # Required [trigger step configuration]
@@ -138,7 +138,7 @@ The plugin supports conditional execution of pipeline steps using the `if` key,
138138
steps:
139139
- label: "Triggering pipelines with plugin"
140140
plugins:
141-
- monorepo-diff#v1.5.1:
141+
- monorepo-diff#v1.5.2:
142142
diff: git diff --name-only HEAD~1
143143
watch:
144144
- path: services/api
@@ -151,20 +151,20 @@ steps:
151151
if: build.tag != null
152152
```
153153

154-
In the example above,
154+
In the example above,
155+
155156
- The `deploy-api` trigger will only run on the main branch or branches matching `release/*`.
156157
- The `web deployment` command will run only if the build has a tag.
157158

158-
159159
#### `diff` (optional)
160160

161161
This will run the script provided to determine the folder changes.
162162
Depending on your use case, you may want to determine the point where the branch occurs
163-
https://stackoverflow.com/questions/1527234/finding-a-branch-point-with-git and perform a diff against the branch point.
163+
<https://stackoverflow.com/questions/1527234/finding-a-branch-point-with-git> and perform a diff against the branch point.
164164

165165
Default: `git diff --name-only HEAD~1`
166166

167-
#### Sample output:
167+
#### Sample output
168168

169169
```
170170
README.md
@@ -201,7 +201,7 @@ git diff --name-only "$LATEST_TAG"
201201
steps:
202202
- label: "Triggering pipelines"
203203
plugins:
204-
- monorepo-diff#v1.5.1:
204+
- monorepo-diff#v1.5.2:
205205
diff: "git diff --name-only HEAD~1"
206206
watch:
207207
- path: "bar-service/"
@@ -228,7 +228,7 @@ A default `config` to run if no paths are matched, the `config` key is not requi
228228
steps:
229229
- label: "Triggering pipelines"
230230
plugins:
231-
- monorepo-diff#v1.5.1:
231+
- monorepo-diff#v1.5.2:
232232
diff: "git diff --name-only HEAD~1"
233233
watch:
234234
- path: "bar-service/"
@@ -250,7 +250,7 @@ The object values provided in this configuration will be appended to `env` prope
250250
steps:
251251
- label: "Triggering pipelines"
252252
plugins:
253-
- monorepo-diff#v1.5.1:
253+
- monorepo-diff#v1.5.2:
254254
diff: "git diff --name-only HEAD~1"
255255
watch:
256256
- path: "foo-service/"
@@ -272,7 +272,7 @@ Add `log_level` property to set the log level. Supported log levels are `debug`
272272
steps:
273273
- label: "Triggering pipelines"
274274
plugins:
275-
- monorepo-diff#v1.5.1:
275+
- monorepo-diff#v1.5.2:
276276
diff: "git diff --name-only HEAD~1"
277277
log_level: "debug" # defaults to "info"
278278
watch:
@@ -303,7 +303,7 @@ By setting `wait` to `true`, the build will wait until the triggered pipeline bu
303303
steps:
304304
- label: "Triggering pipelines"
305305
plugins:
306-
- monorepo-diff#v1.5.1:
306+
- monorepo-diff#v1.5.2:
307307
diff: "git diff --name-only $(head -n 1 last_successful_build)"
308308
interpolation: false
309309
env:
@@ -358,7 +358,6 @@ Thanks to [@chronotc](https://github.com/chronotc) and [@adikari](https://github
358358

359359
MIT (see [LICENSE](LICENSE))
360360

361-
362361
## How to Contribute
363362

364363
Please read [contributing guide](https://github.com/buildkite-plugins/monorepo-diff-buildkite-plugin/blob/master/CONTRIBUTING.md).

0 commit comments

Comments
 (0)