Skip to content

Commit

Permalink
Include documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nosmo committed Nov 22, 2018
1 parent 66c817c commit f45b908
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,25 @@ job('downstreamJob') {
}
```

### Pipeline support

The plugin supports use with the Jenkins pipeline plugin, but pipeline scripts that use the Comment File trigger should ensure that they stash and unstash files appropriately as stages triggered on remote nodes such as containers will be inaccessible unless explicitly transferred to master at the end of a pipeline using similar to the following:

```
node(myNode) {
stage('plan'){
sh: "command > outfile.txt"
stash name: "my-stash", includes: "outfile.txt"
}
}
node("master") {
unstash "my-stash"
}
```

If the job is configured appropriately, the contents of outfile.txt will be posted as a comment to the PR.

### Updates

See [CHANGELOG](CHANGELOG.md)
Expand Down

0 comments on commit f45b908

Please sign in to comment.