Skip to content

Commit 424f155

Browse files
authored
Merge pull request #179 from /issues/177
Insert PR body.
2 parents fd9fe0c + ec0bbc0 commit 424f155

6 files changed

Lines changed: 27 additions & 4 deletions

File tree

docs/Configuration.adoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1+
:imagesdir: images
12
== GitHub integration plugin
23

3-
=== Pull Requests Trigger
4-
==== Triggering
4+
=== Triggers common configuration:
55
- Configure https://wiki.jenkins-ci.org/display/JENKINS/GitHub+Plugin[github-plugin] according to it's documentation.
66
- Set `GitHub project property` with link to your GitHub repository in Job settings.
7+
image::github-project-property.png[]
8+
9+
=== Pull Requests Trigger
10+
==== Triggering
711
- Configure https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin[git-plugin]: add any repo name i.e. 'origin-pull' and set refspec to
812
`+refs/pull/${GITHUB_PR_NUMBER}/merge:refs/remotes/origin-pull/pull/${GITHUB_PR_NUMBER}/merge` if you want run
913
build for merged state or '/head' for building exact PR commits, or `$GITHUB_PR_COND_REF` if you want 'head' state
@@ -29,6 +33,7 @@ like `Build #${BUILD_NUMBER} started`
2933
- `GITHUB_PR_TARGET_BRANCH` - `master`
3034
- `GITHUB_PR_SOURCE_BRANCH` - `KostyaSha-patch-9`
3135
- `GITHUB_PR_AUTHOR_EMAIL` - `KostyaSha@users.noreply.github.com`
36+
- `GITHUB_PR_BODY` -
3237
- `GITHUB_PR_SHORT_DESC` -
3338
- `GITHUB_PR_TITLE` - `Update README.md`
3439
- `GITHUB_PR_URL` - `https://github.com/KostyaSha/test-repo/pull/21`
@@ -44,8 +49,6 @@ like `Build #${BUILD_NUMBER} started`
4449
=== Branch Trigger
4550

4651
==== Triggering
47-
- Configure https://wiki.jenkins-ci.org/display/JENKINS/GitHub+Plugin[github-plugin] according to it's documentation.
48-
- Set `GitHub project property` with link to your GH repository in Job settings.
4952
- Configure Git SCM with variables refspec: `refs/heads/${GITHUB_BRANCH_NAME}:refs/remotes/origin/${GITHUB_BRANCH_NAME}`
5053
url `${GITHUB_REPO_GIT_URL}`, branchspec `${GITHUB_BRANCH_NAME}`.
5154

21.8 KB
Loading

github-pullrequest-plugin/src/main/java/org/jenkinsci/plugins/github/pullrequest/GitHubPRCause.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ public class GitHubPRCause extends GitHubCause<GitHubPRCause> {
3030
private String targetBranch;
3131
private String sourceBranch;
3232
private String prAuthorEmail;
33+
private String body;
3334

3435
private String sourceRepoOwner;
3536
private String triggerSenderName = "";
@@ -65,6 +66,7 @@ public GitHubPRCause(GitHubPRPullRequest pr,
6566
pr.getUserEmail(), pr.getTitle(), pr.getHtmlUrl(), pr.getSourceRepoOwner(),
6667
pr.getLabels(),
6768
triggerSender, skip, reason, "", "", pr.getState());
69+
this.body = pr.getBody();
6870
}
6971

7072
//FIXME (sizes) ParameterNumber: More than 7 parameters (found 15).
@@ -229,6 +231,15 @@ public GitHubPRCause withCommentBodyMatch(String commentBodyMatch) {
229231
return this;
230232
}
231233

234+
public String getBody() {
235+
return body;
236+
}
237+
238+
public GitHubPRCause withBody(String body) {
239+
this.body = body;
240+
return this;
241+
}
242+
232243
@Override
233244
public String getShortDescription() {
234245
return "GitHub PR #<a href=\"" + getHtmlUrl() + "\">" + number + "</a>, " + getReason();

github-pullrequest-plugin/src/main/java/org/jenkinsci/plugins/github/pullrequest/GitHubPRPullRequest.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ public class GitHubPRPullRequest {
3636
// https://github.com/kohsuke/github-api/issues/178
3737
private final Date issueUpdatedAt;
3838
private String title;
39+
private String body;
3940
private Date prUpdatedAt;
4041
private String headSha;
4142
private String headRef;
@@ -105,6 +106,7 @@ public GitHubPRPullRequest(GHPullRequest pr) throws IOException {
105106

106107
sourceRepoOwner = remoteRepo.getOwnerName();
107108
state = pr.getState().toString();
109+
body = pr.getBody();
108110
}
109111

110112
public int getNumber() {
@@ -135,6 +137,10 @@ public String getTitle() {
135137
return title;
136138
}
137139

140+
public String getBody() {
141+
return body;
142+
}
143+
138144
@Nonnull
139145
public Set<String> getLabels() {
140146
return isNull(labels) ? Collections.<String>emptySet() : labels;

github-pullrequest-plugin/src/main/java/org/jenkinsci/plugins/github/pullrequest/data/GitHubPREnv.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ public enum GitHubPREnv {
1818
TARGET_BRANCH,
1919
SOURCE_BRANCH,
2020
AUTHOR_EMAIL,
21+
BODY,
2122
SHORT_DESC,
2223
TITLE,
2324
URL,

github-pullrequest-plugin/src/main/java/org/jenkinsci/plugins/github/pullrequest/trigger/JobRunnerForCause.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
import static org.jenkinsci.plugins.github.pullrequest.data.GitHubPREnv.COMMIT_AUTHOR_EMAIL;
5151
import static org.jenkinsci.plugins.github.pullrequest.data.GitHubPREnv.COMMIT_AUTHOR_NAME;
5252
import static org.jenkinsci.plugins.github.pullrequest.data.GitHubPREnv.COND_REF;
53+
import static org.jenkinsci.plugins.github.pullrequest.data.GitHubPREnv.BODY;
5354
import static org.jenkinsci.plugins.github.pullrequest.data.GitHubPREnv.HEAD_SHA;
5455
import static org.jenkinsci.plugins.github.pullrequest.data.GitHubPREnv.NUMBER;
5556
import static org.jenkinsci.plugins.github.pullrequest.data.GitHubPREnv.SHORT_DESC;
@@ -277,6 +278,7 @@ public QueueTaskFuture<?> startJob(GitHubPRCause cause, Cause additionalCause) {
277278
TARGET_BRANCH.param(cause.getTargetBranch()),
278279
SOURCE_BRANCH.param(cause.getSourceBranch()),
279280
AUTHOR_EMAIL.param(cause.getPRAuthorEmail()),
281+
BODY.param(cause.getBody()),
280282
SHORT_DESC.param(cause.getShortDescription()),
281283
TITLE.param(cause.getTitle()),
282284
URL.param(cause.getHtmlUrl().toString()),

0 commit comments

Comments
 (0)