Skip to content

Commit 94bcfe3

Browse files
pvillard31pvillard31
authored
Add support for specifying Author and Committer (issue #2199) (#2200)
* Add support for specifying Author and Committer * review wrt test coverage * review
1 parent eb12f66 commit 94bcfe3

55 files changed

Lines changed: 4316 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/main/java/org/kohsuke/github/GHContent.java‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,34 @@ static String getApiRoute(GHRepository repository, String path) {
5656
public GHContent() {
5757
}
5858

59+
/**
60+
* Creates a builder that can be used to delete this file.
61+
*
62+
* <p>
63+
* Unlike the {@link #delete(String)} convenience methods, this builder supports setting the author and committer of
64+
* the resulting commit.
65+
*
66+
* @return a content deleter
67+
* @see GHContentDeleter
68+
*/
69+
public GHContentDeleter createDelete() {
70+
return new GHContentDeleter(this);
71+
}
72+
73+
/**
74+
* Creates a builder that can be used to update this file's content.
75+
*
76+
* <p>
77+
* Unlike the {@link #update(String, String)} convenience methods, this builder supports setting the author and
78+
* committer of the resulting commit.
79+
*
80+
* @return a content updater
81+
* @see GHContentUpdater
82+
*/
83+
public GHContentUpdater createUpdate() {
84+
return new GHContentUpdater(this);
85+
}
86+
5987
/**
6088
* Delete gh content update response.
6189
*

‎src/main/java/org/kohsuke/github/GHContentBuilder.java‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
package org.kohsuke.github;
22

3+
import com.fasterxml.jackson.annotation.JsonInclude;
4+
import com.fasterxml.jackson.annotation.JsonInclude.Include;
5+
36
import java.io.IOException;
47
import java.nio.charset.StandardCharsets;
8+
import java.time.Instant;
59
import java.util.Base64;
10+
import java.util.Date;
611

712
// TODO: Auto-generated Javadoc
813
/**
@@ -15,6 +20,19 @@
1520
* @see GHRepository#createContent() GHRepository#createContent()
1621
*/
1722
public final class GHContentBuilder {
23+
@JsonInclude(Include.NON_NULL)
24+
private static final class UserInfo {
25+
private final String date;
26+
private final String email;
27+
private final String name;
28+
29+
private UserInfo(String name, String email, Instant date) {
30+
this.name = name;
31+
this.email = email;
32+
this.date = date != null ? GitHubClient.printInstant(date) : null;
33+
}
34+
}
35+
1836
private String path;
1937
private final GHRepository repo;
2038
private final Requester req;
@@ -30,6 +48,52 @@ public final class GHContentBuilder {
3048
this.req = repo.root().createRequest().method("PUT");
3149
}
3250

51+
/**
52+
* Configures the author of the commit. If not specified, the authenticated user is used as the author.
53+
*
54+
* @param name
55+
* the name of the author
56+
* @param email
57+
* the email of the author
58+
* @return the gh content builder
59+
*/
60+
public GHContentBuilder author(String name, String email) {
61+
return author(name, email, (Instant) null);
62+
}
63+
64+
/**
65+
* Configures the author of the commit. If not specified, the authenticated user is used as the author.
66+
*
67+
* @param name
68+
* the name of the author
69+
* @param email
70+
* the email of the author
71+
* @param date
72+
* the date of the authoring
73+
* @return the gh content builder
74+
* @deprecated use {@link #author(String, String, Instant)} instead
75+
*/
76+
@Deprecated
77+
public GHContentBuilder author(String name, String email, Date date) {
78+
return author(name, email, GitHubClient.toInstantOrNull(date));
79+
}
80+
81+
/**
82+
* Configures the author of the commit. If not specified, the authenticated user is used as the author.
83+
*
84+
* @param name
85+
* the name of the author
86+
* @param email
87+
* the email of the author
88+
* @param date
89+
* the timestamp for the authoring
90+
* @return the gh content builder
91+
*/
92+
public GHContentBuilder author(String name, String email, Instant date) {
93+
req.with("author", new UserInfo(name, email, date));
94+
return this;
95+
}
96+
3397
/**
3498
* Branch gh content builder.
3599
*
@@ -59,6 +123,52 @@ public GHContentUpdateResponse commit() throws IOException {
59123
return response;
60124
}
61125

126+
/**
127+
* Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
128+
*
129+
* @param name
130+
* the name of the committer
131+
* @param email
132+
* the email of the committer
133+
* @return the gh content builder
134+
*/
135+
public GHContentBuilder committer(String name, String email) {
136+
return committer(name, email, (Instant) null);
137+
}
138+
139+
/**
140+
* Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
141+
*
142+
* @param name
143+
* the name of the committer
144+
* @param email
145+
* the email of the committer
146+
* @param date
147+
* the date of the commit
148+
* @return the gh content builder
149+
* @deprecated use {@link #committer(String, String, Instant)} instead
150+
*/
151+
@Deprecated
152+
public GHContentBuilder committer(String name, String email, Date date) {
153+
return committer(name, email, GitHubClient.toInstantOrNull(date));
154+
}
155+
156+
/**
157+
* Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
158+
*
159+
* @param name
160+
* the name of the committer
161+
* @param email
162+
* the email of the committer
163+
* @param date
164+
* the timestamp of the commit
165+
* @return the gh content builder
166+
*/
167+
public GHContentBuilder committer(String name, String email, Instant date) {
168+
req.with("committer", new UserInfo(name, email, date));
169+
return this;
170+
}
171+
62172
/**
63173
* Content gh content builder.
64174
*

‎src/main/java/org/kohsuke/github/GHContentDeleter.java‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
package org.kohsuke.github;
2+
3+
import com.fasterxml.jackson.annotation.JsonInclude;
4+
import com.fasterxml.jackson.annotation.JsonInclude.Include;
5+
6+
import java.io.IOException;
7+
import java.time.Instant;
8+
import java.util.Date;
9+
10+
/**
11+
* Builder for deleting repository content with support for specifying author and committer information.
12+
*
13+
* <p>
14+
* Obtain an instance via {@link GHContent#createDelete()}.
15+
*
16+
* @see GHContent#createDelete()
17+
*/
18+
public final class GHContentDeleter {
19+
@JsonInclude(Include.NON_NULL)
20+
private static final class UserInfo {
21+
private final String date;
22+
private final String email;
23+
private final String name;
24+
25+
private UserInfo(String name, String email, Instant date) {
26+
this.name = name;
27+
this.email = email;
28+
this.date = date != null ? GitHubClient.printInstant(date) : null;
29+
}
30+
}
31+
32+
private final GHContent content;
33+
private final Requester req;
34+
35+
GHContentDeleter(GHContent content) {
36+
this.content = content;
37+
final GHRepository repository = content.getOwner();
38+
this.req = repository.root()
39+
.createRequest()
40+
.method("DELETE")
41+
.inBody()
42+
.with("path", content.getPath())
43+
.with("sha", content.getSha());
44+
}
45+
46+
/**
47+
* Configures the author of the commit. If not specified, the authenticated user is used as the author.
48+
*
49+
* @param name
50+
* the name of the author
51+
* @param email
52+
* the email of the author
53+
* @return this deleter
54+
*/
55+
public GHContentDeleter author(String name, String email) {
56+
return author(name, email, (Instant) null);
57+
}
58+
59+
/**
60+
* Configures the author of the commit. If not specified, the authenticated user is used as the author.
61+
*
62+
* @param name
63+
* the name of the author
64+
* @param email
65+
* the email of the author
66+
* @param date
67+
* the date of the authoring
68+
* @return this deleter
69+
* @deprecated use {@link #author(String, String, Instant)} instead
70+
*/
71+
@Deprecated
72+
public GHContentDeleter author(String name, String email, Date date) {
73+
return author(name, email, GitHubClient.toInstantOrNull(date));
74+
}
75+
76+
/**
77+
* Configures the author of the commit. If not specified, the authenticated user is used as the author.
78+
*
79+
* @param name
80+
* the name of the author
81+
* @param email
82+
* the email of the author
83+
* @param date
84+
* the timestamp for the authoring
85+
* @return this deleter
86+
*/
87+
public GHContentDeleter author(String name, String email, Instant date) {
88+
req.with("author", new UserInfo(name, email, date));
89+
return this;
90+
}
91+
92+
/**
93+
* Sets the branch to delete the content from.
94+
*
95+
* @param branch
96+
* the branch name
97+
* @return this deleter
98+
*/
99+
public GHContentDeleter branch(String branch) {
100+
req.with("branch", branch);
101+
return this;
102+
}
103+
104+
/**
105+
* Commits the deletion.
106+
*
107+
* @return the response containing the commit information
108+
* @throws IOException
109+
* the io exception
110+
*/
111+
public GHContentUpdateResponse commit() throws IOException {
112+
final GHRepository repository = content.getOwner();
113+
GHContentUpdateResponse response = req.withUrlPath(GHContent.getApiRoute(repository, content.getPath()))
114+
.fetch(GHContentUpdateResponse.class);
115+
116+
response.getCommit().wrapUp(repository);
117+
return response;
118+
}
119+
120+
/**
121+
* Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
122+
*
123+
* @param name
124+
* the name of the committer
125+
* @param email
126+
* the email of the committer
127+
* @return this deleter
128+
*/
129+
public GHContentDeleter committer(String name, String email) {
130+
return committer(name, email, (Instant) null);
131+
}
132+
133+
/**
134+
* Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
135+
*
136+
* @param name
137+
* the name of the committer
138+
* @param email
139+
* the email of the committer
140+
* @param date
141+
* the date of the commit
142+
* @return this deleter
143+
* @deprecated use {@link #committer(String, String, Instant)} instead
144+
*/
145+
@Deprecated
146+
public GHContentDeleter committer(String name, String email, Date date) {
147+
return committer(name, email, GitHubClient.toInstantOrNull(date));
148+
}
149+
150+
/**
151+
* Configures the committer of the commit. If not specified, the authenticated user is used as the committer.
152+
*
153+
* @param name
154+
* the name of the committer
155+
* @param email
156+
* the email of the committer
157+
* @param date
158+
* the timestamp of the commit
159+
* @return this deleter
160+
*/
161+
public GHContentDeleter committer(String name, String email, Instant date) {
162+
req.with("committer", new UserInfo(name, email, date));
163+
return this;
164+
}
165+
166+
/**
167+
* Sets the commit message.
168+
*
169+
* @param message
170+
* the commit message
171+
* @return this deleter
172+
*/
173+
public GHContentDeleter message(String message) {
174+
req.with("message", message);
175+
return this;
176+
}
177+
}

0 commit comments

Comments
 (0)