Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update @since version #255

Merged
merged 1 commit into from
Nov 8, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

/**
* Represents a strategy for constructing GitHub status notifications
* @since TODO
* @since 2.3.2
*/
public abstract class AbstractGitHubNotificationStrategy implements ExtensionPoint {

Expand All @@ -40,7 +40,7 @@ public abstract class AbstractGitHubNotificationStrategy implements ExtensionPoi
* @param notificationContext {@link GitHubNotificationContext} the context details
* @param listener the listener
* @return a list of notification requests
* @since TODO
* @since 2.3.2
*/
public abstract List<GitHubNotificationRequest> notifications(GitHubNotificationContext notificationContext, TaskListener listener);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

/**
* Head corresponding to a branch.
* @since FIXME
* @since 2.0.0
*/
public class BranchSCMHead extends SCMHead {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

/**
* Default implementation of {@link AbstractGitHubNotificationStrategy}
* @since TODO
* @since 2.3.2
*/
public final class DefaultGitHubNotificationStrategy extends AbstractGitHubNotificationStrategy {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
/**
* A {@link ViewJobFilter} that matches {@link BranchSCMHead} based branches.
*
* @since FIXME
* @since 2.0.0
*/
public class GitHubBranchFilter extends ViewJobFilter {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
* When creating a new point of notification (e.g. on build completion), populate this object with
* the relevant details accessible at that point.
* When implementing a notification strategy, be aware that some details may be absent depending on the point of notification.
* @since TODO
* @since 2.3.2
*/
public final class GitHubNotificationContext {
private final Job<?, ?> job;
Expand All @@ -48,7 +48,7 @@ public final class GitHubNotificationContext {
private final SCMHead head;

/**
* @since TODO
* @since 2.3.2
*/
private GitHubNotificationContext(Job<?, ?> job, Run<?, ?> build, SCMSource source, SCMHead head) {
this.job = job;
Expand All @@ -64,7 +64,7 @@ public static GitHubNotificationContext build(@Nullable Job<?, ?> job, @Nullable
/**
* Returns the job, if any, associated with the planned notification event
* @return Job
* @since TODO
* @since 2.3.2
*/
public Job<?, ?> getJob() {
return job;
Expand All @@ -73,7 +73,7 @@ public static GitHubNotificationContext build(@Nullable Job<?, ?> job, @Nullable
/**
* Returns the run, if any, associated with the planned notification event
* @return Run
* @since TODO
* @since 2.3.2
*/
public Run<?, ?> getBuild() {
return build;
Expand All @@ -82,7 +82,7 @@ public static GitHubNotificationContext build(@Nullable Job<?, ?> job, @Nullable
/**
* Returns the SCMSource associated with the planned notification event
* @return SCMSource
* @since TODO
* @since 2.3.2
*/
public SCMSource getSource() {
return source;
Expand All @@ -91,7 +91,7 @@ public SCMSource getSource() {
/**
* Returns the SCMHead associated with the planned notification event
* @return SCMHead
* @since TODO
* @since 2.3.2
*/
public SCMHead getHead() {
return head;
Expand Down Expand Up @@ -142,7 +142,7 @@ public int hashCode() {
* Retrieves default context
* @param listener Listener for the build, if any
* @return Default notification context
* @since TODO
* @since 2.3.2
*/
public String getDefaultContext(TaskListener listener) {
if (head instanceof PullRequestSCMHead) {
Expand All @@ -160,7 +160,7 @@ public String getDefaultContext(TaskListener listener) {
* Retrieves default URL
* @param listener Listener for the build, if any
* @return Default notification URL backref
* @since TODO
* @since 2.3.2
*/
public String getDefaultUrl(TaskListener listener) {
String url = null;
Expand All @@ -184,7 +184,7 @@ else if (null != job) {
* Retrieves default notification message
* @param listener Listener for the build, if any
* @return Default notification message
* @since TODO
* @since 2.3.2
*/
public String getDefaultMessage(TaskListener listener) {
if (null != build) {
Expand All @@ -210,7 +210,7 @@ public String getDefaultMessage(TaskListener listener) {
* Retrieves default notification state
* @param listener Listener for the build, if any
* @return Default notification state
* @since TODO
* @since 2.3.2
*/
public GHCommitState getDefaultState(TaskListener listener) {
if (null != build && !build.isBuilding()) {
Expand All @@ -234,7 +234,7 @@ public GHCommitState getDefaultState(TaskListener listener) {
* Retrieves whether plugin should ignore errors when updating the GitHub status
* @param listener Listener for the build, if any
* @return Default ignore errors policy
* @since TODO
* @since 2.3.2
*/
public boolean getDefaultIgnoreError(TaskListener listener) {
return null == build || null == build.getResult();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
* Notifications are differentiated by their Context label. If two notification requests with the same Context label are
* provided, one will override the other.
* @see <a href="https://developer.github.com/v3/repos/statuses/">Github API</a> for details of the purpose of each notification field.
* @since TODO
* @since 2.3.2
*/
public class GitHubNotificationRequest {

Expand All @@ -44,7 +44,7 @@ public class GitHubNotificationRequest {
private final boolean ignoreError;

/**
* @since TODO
* @since 2.3.2
*/
private GitHubNotificationRequest(String context, String url, String message, GHCommitState state, boolean ignoreError) {
this.context = context;
Expand All @@ -61,7 +61,7 @@ public static GitHubNotificationRequest build(String context, String url, String
/**
* Returns the context label to be used for a notification
* @return context
* @since TODO
* @since 2.3.2
*/
public String getContext() {
return context;
Expand All @@ -70,7 +70,7 @@ public String getContext() {
/**
* Returns the URL to be supplied with a notification
* @return url
* @since TODO
* @since 2.3.2
*/
public String getUrl() {
return url;
Expand All @@ -79,7 +79,7 @@ public String getUrl() {
/**
* Returns the message for a notification
* @return message
* @since TODO
* @since 2.3.2
*/
public String getMessage() {
return message;
Expand All @@ -88,7 +88,7 @@ public String getMessage() {
/**
* Returns the commit state of a notification
* @return state
* @since TODO
* @since 2.3.2
*/
public GHCommitState getState() {
return state;
Expand All @@ -97,7 +97,7 @@ public GHCommitState getState() {
/**
* Returns whether the notification processor should ignore errors when interacting with GitHub
* @return ignoreError
* @since TODO
* @since 2.3.2
*/
public boolean isIgnoreError() {
return ignoreError;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
/**
* A deferred source of permission information about a repository.
*
* @since TODO
* @since 2.2.2
*/
public abstract class GitHubPermissionsSource {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
/**
* A {@link ViewJobFilter} that matches {@link PullRequestSCMHead} based branches.
*
* @since FIXME
* @since 2.0.0
*/
public class GitHubPullRequestFilter extends ViewJobFilter {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ public class GitHubSCMSourceContext
/**
* Strategies used to notify Github of build status.
*
* @since TODO
* @since 2.3.2
*/
private final List<AbstractGitHubNotificationStrategy> notificationStrategies = new ArrayList<>();

Expand Down Expand Up @@ -161,7 +161,7 @@ public final Set<ChangeRequestCheckoutStrategy> forkPRStrategies() {
/**
* Returns the strategies used to notify Github of build status.
* @return the strategies used to notify Github of build status.
* @since TODO
* @since 2.3.2
*/
public final List<AbstractGitHubNotificationStrategy> notificationStrategies() {
if (notificationStrategies.isEmpty()) {
Expand Down Expand Up @@ -258,7 +258,7 @@ public GitHubSCMSourceContext withForkPRStrategies(Set<ChangeRequestCheckoutStra
*
* @param strategies the strategies used to notify Github of build status.
* @return {@code this} for method chaining.
* @since TODO
* @since 2.3.2
*/
@NonNull
public final GitHubSCMSourceContext withNotificationStrategies(List<AbstractGitHubNotificationStrategy> strategies) {
Expand All @@ -275,7 +275,7 @@ public final GitHubSCMSourceContext withNotificationStrategies(List<AbstractGitH
* Add a strategy used to notify Github of build status.
* @param strategy a strategy used to notify Github of build status.
* @return {@code this} for method chaining.
* @since TODO
* @since 2.3.2
*/
@NonNull
public final GitHubSCMSourceContext withNotificationStrategy(AbstractGitHubNotificationStrategy strategy) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
/**
* A {@link Discovery} trait for GitHub that will discover tags on the repository.
*
* @since TODO
* @since 2.3.0
*/
public class TagDiscoveryTrait extends SCMSourceTrait {
/**
Expand Down