Package io.github.cdklabs.projen.github

Interface StaleBehavior

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StaleBehavior.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.088Z")
@Stability(Experimental)
public interface StaleBehavior
extends software.amazon.jsii.JsiiSerializable

(experimental) Stale behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	StaleBehavior.Builder	A builder for StaleBehavior
static class	StaleBehavior.Jsii$Proxy	An implementation for StaleBehavior

Method Summary

Modifier and Type	Method	Description
static StaleBehavior.Builder	builder()
default String	getCloseMessage()	(experimental) The comment to add to the issue/PR when it's closed.
default Number	getDaysBeforeClose()	(experimental) Days until the issue/PR is closed after it is marked as "Stale".
default Number	getDaysBeforeStale()	(experimental) How many days until the issue or pull request is marked as "Stale".
default Boolean	getEnabled()	(experimental) Determines if this behavior is enabled.
default List<String>	getExemptLabels()	(experimental) Label which exempt an issue/PR from becoming stale.
default String	getStaleLabel()	(experimental) The label to apply to the issue/PR when it becomes stale.
default String	getStaleMessage()	(experimental) The comment to add to the issue/PR when it becomes stale.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCloseMessage

@Stability(Experimental)
@Nullable
default String getCloseMessage()

(experimental) The comment to add to the issue/PR when it's closed.

Default: "Closing this pull request as it hasn\'t seen activity for a while. Please add a comment

getDaysBeforeClose

@Stability(Experimental)
@Nullable
default Number getDaysBeforeClose()

(experimental) Days until the issue/PR is closed after it is marked as "Stale".

Set to -1 to disable.

Default: -

getDaysBeforeStale

@Stability(Experimental)
@Nullable
default Number getDaysBeforeStale()

(experimental) How many days until the issue or pull request is marked as "Stale".

Set to -1 to disable.

Default: -

getEnabled

@Stability(Experimental)
@Nullable
default Boolean getEnabled()

(experimental) Determines if this behavior is enabled.

Same as setting daysBeforeStale and daysBeforeClose to -1.

Default: true

getExemptLabels

@Stability(Experimental)
@Nullable
default List<String> getExemptLabels()

(experimental) Label which exempt an issue/PR from becoming stale.

Set to [] to disable.

Default: - ["backlog"]

getStaleLabel

@Stability(Experimental)
@Nullable
default String getStaleLabel()

(experimental) The label to apply to the issue/PR when it becomes stale.

Default: "stale"

getStaleMessage

@Stability(Experimental)
@Nullable
default String getStaleMessage()

(experimental) The comment to add to the issue/PR when it becomes stale.

Default: "This pull request is now marked as stale because hasn\'t seen activity for a while. Add a comment or it will be closed soon."

builder

@Stability(Experimental)
static StaleBehavior.Builder builder()

Returns:

a StaleBehavior.Builder of StaleBehavior