Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions > com.github.actions.actions.stale.v9.Stale

With1.3.0

Properties
Methods

class With

Known subtypes in package:
Known usages in package:
All versions:

Properties

link

`repo-token`: String?Source

Token for the repository. Can be passed in using {{ secrets.GITHUB_TOKEN }}.

Default if unspecified: "${{ github.token }}"
link

`stale-issue-message`: String?Source

The message to post on the issue when tagging it. If none provided, will not mark issues stale.
link

`stale-pr-message`: String?Source

The message to post on the pull request when tagging it. If none provided, will not mark pull requests stale.
link

`close-issue-message`: String?Source

The message to post on the issue when closing it. If none provided, will not comment when closing an issue.
link

`close-pr-message`: String?Source

The message to post on the pull request when closing it. If none provided, will not comment when closing a pull requests.
link

`days-before-stale`: Float?Source

The number of days old an issue or a pull request can be before marking it stale. Set to -1 to never mark issues or pull requests as stale automatically.

Default if unspecified: "60"
link

`days-before-issue-stale`: String?Source

The number of days old an issue can be before marking it stale. Set to -1 to never mark issues as stale automatically. Override "days-before-stale" option regarding only the issues.
link

`days-before-pr-stale`: Int?Source

The number of days old a pull request can be before marking it stale. Set to -1 to never mark pull requests as stale automatically. Override "days-before-stale" option regarding only the pull requests.
link

`days-before-close`: Int?Source

The number of days to wait to close an issue or a pull request after it being marked stale. Set to -1 to never close stale issues or pull requests.

Default if unspecified: "7"
link

`days-before-issue-close`: Int?Source

The number of days to wait to close an issue after it being marked stale. Set to -1 to never close stale issues. Override "days-before-close" option regarding only the issues.
link

`days-before-pr-close`: Int?Source

The number of days to wait to close a pull request after it being marked stale. Set to -1 to never close stale pull requests. Override "days-before-close" option regarding only the pull requests.
link

`stale-issue-label`: String?Source

The label to apply when an issue is stale.

Default if unspecified: "Stale"
link

`close-issue-label`: String?Source

The label to apply when an issue is closed.
link

hidden

`exempt-issue-labels-list`: Listing<String>?Source

The labels that mean an issue is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2").

Default if unspecified: ""
link

`exempt-issue-labels`: String?Source

The labels that mean an issue is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2").

Default if unspecified: ""

To set as a Listing, use exempt-issue-labels-list.
link

`close-issue-reason`: ("completed"|"not_planned")?Source

The reason to use when closing an issue.

Default if unspecified: "not_planned"
link

`stale-pr-label`: String?Source

The label to apply when a pull request is stale.

Default if unspecified: "Stale"
link

`close-pr-label`: String?Source

The label to apply when a pull request is closed.
link

hidden

`exempt-pr-labels-list`: Listing<String>?Source

The labels that mean a pull request is exempt from being marked as stale. Separate multiple labels with commas (eg. "label1,label2").

Default if unspecified: ""
link

`exempt-pr-labels`: String?Source

The labels that mean a pull request is exempt from being marked as stale. Separate multiple labels with commas (eg. "label1,label2").

Default if unspecified: ""

To set as a Listing, use exempt-pr-labels-list.
link

hidden

`exempt-milestones-list`: Listing<String>?Source

The milestones that mean an issue or a pull request is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2").

Default if unspecified: ""
link

`exempt-milestones`: String?Source

The milestones that mean an issue or a pull request is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2").

Default if unspecified: ""

To set as a Listing, use exempt-milestones-list.
link

hidden

`exempt-issue-milestones-list`: Listing<String>?Source

The milestones that mean an issue is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2"). Override "exempt-milestones" option regarding only the issues.

Default if unspecified: ""
link

`exempt-issue-milestones`: String?Source

The milestones that mean an issue is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2"). Override "exempt-milestones" option regarding only the issues.

Default if unspecified: ""

To set as a Listing, use exempt-issue-milestones-list.
link

hidden

`exempt-pr-milestones-list`: Listing<String>?Source

The milestones that mean a pull request is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2"). Override "exempt-milestones" option regarding only the pull requests.

Default if unspecified: ""
link

`exempt-pr-milestones`: String?Source

The milestones that mean a pull request is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2"). Override "exempt-milestones" option regarding only the pull requests.

Default if unspecified: ""

To set as a Listing, use exempt-pr-milestones-list.
link

`exempt-all-milestones`: Boolean?Source

Exempt all issues and pull requests with milestones from being marked as stale. Default to false.

Default if unspecified: "false"
link

`exempt-all-issue-milestones`: Boolean?Source

Exempt all issues with milestones from being marked as stale. Override "exempt-all-milestones" option regarding only the issues.

Default if unspecified: ""
link

`exempt-all-pr-milestones`: Boolean?Source

Exempt all pull requests with milestones from being marked as stale. Override "exempt-all-milestones" option regarding only the pull requests.

Default if unspecified: ""
link

hidden

`only-labels-list`: Listing<String>?Source

Only issues or pull requests with all of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels.

Default if unspecified: ""
link

`only-labels`: String?Source

Only issues or pull requests with all of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels.

Default if unspecified: ""

To set as a Listing, use only-labels-list.
link

hidden

`any-of-labels-list`: Listing<String>?Source

Only issues or pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels.

Default if unspecified: ""
link

`any-of-labels`: String?Source

Only issues or pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels.

Default if unspecified: ""

To set as a Listing, use any-of-labels-list.
link

hidden

`any-of-issue-labels-list`: Listing<String>?Source

Only issues with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the issues.

Default if unspecified: ""
link

`any-of-issue-labels`: String?Source

Only issues with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the issues.

Default if unspecified: ""

To set as a Listing, use any-of-issue-labels-list.
link

hidden

`any-of-pr-labels-list`: Listing<String>?Source

Only pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the pull requests.

Default if unspecified: ""
link

`any-of-pr-labels`: String?Source

Only pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the pull requests.

Default if unspecified: ""

To set as a Listing, use any-of-pr-labels-list.
link

hidden

`only-issue-labels-list`: Listing<String>?Source

Only issues with all of these labels are checked if stale. Defaults to [] (disabled) and can be a comma-separated list of labels. Override "only-labels" option regarding only the issues.

Default if unspecified: ""
link

`only-issue-labels`: String?Source

Only issues with all of these labels are checked if stale. Defaults to [] (disabled) and can be a comma-separated list of labels. Override "only-labels" option regarding only the issues.

Default if unspecified: ""

To set as a Listing, use only-issue-labels-list.
link

hidden

`only-pr-labels-list`: Listing<String>?Source

Only pull requests with all of these labels are checked if stale. Defaults to [] (disabled) and can be a comma-separated list of labels. Override "only-labels" option regarding only the pull requests.

Default if unspecified: ""
link

`only-pr-labels`: String?Source

Only pull requests with all of these labels are checked if stale. Defaults to [] (disabled) and can be a comma-separated list of labels. Override "only-labels" option regarding only the pull requests.

Default if unspecified: ""

To set as a Listing, use only-pr-labels-list.
link

`operations-per-run`: Int?Source

The maximum number of operations per run, used to control rate limiting (GitHub API CRUD related).

Default if unspecified: "30"
link

`remove-stale-when-updated`: Boolean?Source

Remove stale labels from issues and pull requests when they are updated or commented on.

Default if unspecified: "true"
link

`remove-issue-stale-when-updated`: Boolean?Source

Remove stale labels from issues when they are updated or commented on. Override "remove-stale-when-updated" option regarding only the issues.

Default if unspecified: ""
link

`remove-pr-stale-when-updated`: Boolean?Source

Remove stale labels from pull requests when they are updated or commented on. Override "remove-stale-when-updated" option regarding only the pull requests.

Default if unspecified: ""
link

`debug-only`: Boolean?Source

Run the processor in debug mode without actually performing any operations on live issues.

Default if unspecified: "false"
link

ascending: Boolean?Source

The order to get issues or pull requests. Defaults to false, which is descending.

Default if unspecified: "false"
link

`delete-branch`: Boolean?Source

Delete the git branch after closing a stale pull request.

Default if unspecified: "false"
link

`start-date`: String?Source

The date used to skip the stale action on issue/pull request created before it (ISO 8601 or RFC 2822).

Default if unspecified: ""
link

hidden

`exempt-assignees-list`: Listing<String>?Source

The assignees which exempt an issue or a pull request from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2").

Default if unspecified: ""
link

`exempt-assignees`: String?Source

The assignees which exempt an issue or a pull request from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2").

Default if unspecified: ""

To set as a Listing, use exempt-assignees-list.
link

hidden

`exempt-issue-assignees-list`: Listing<String>?Source

The assignees which exempt an issue from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2"). Override "exempt-assignees" option regarding only the issues.

Default if unspecified: ""
link

`exempt-issue-assignees`: String?Source

The assignees which exempt an issue from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2"). Override "exempt-assignees" option regarding only the issues.

Default if unspecified: ""

To set as a Listing, use exempt-issue-assignees-list.
link

hidden

`exempt-pr-assignees-list`: Listing<String>?Source

The assignees which exempt a pull request from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2"). Override "exempt-assignees" option regarding only the pull requests.

Default if unspecified: ""
link

`exempt-pr-assignees`: String?Source

The assignees which exempt a pull request from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2"). Override "exempt-assignees" option regarding only the pull requests.

Default if unspecified: ""

To set as a Listing, use exempt-pr-assignees-list.
link

`exempt-all-assignees`: Boolean?Source

Exempt all issues and pull requests with assignees from being marked as stale. Default to false.

Default if unspecified: "false"
link

`exempt-all-issue-assignees`: String?Source

Exempt all issues with assignees from being marked as stale. Override "exempt-all-assignees" option regarding only the issues.

Default if unspecified: ""
link

`exempt-all-pr-assignees`: Boolean?Source

Exempt all pull requests with assignees from being marked as stale. Override "exempt-all-assignees" option regarding only the pull requests.

Default if unspecified: ""
link

`exempt-draft-pr`: Boolean?Source

Exempt draft pull requests from being marked as stale. Default to false.

Default if unspecified: "false"
link

`enable-statistics`: Boolean?Source

Display some statistics at the end regarding the stale workflow (only when the logs are enabled).

Default if unspecified: "true"
link

hidden

`labels-to-add-when-unstale-list`: Listing<String>?Source

A comma delimited list of labels to add when an issue or pull request becomes unstale.

Default if unspecified: ""
link

`labels-to-add-when-unstale`: String?Source

A comma delimited list of labels to add when an issue or pull request becomes unstale.

Default if unspecified: ""

To set as a Listing, use labels-to-add-when-unstale-list.
link

hidden

`labels-to-remove-when-stale-list`: Listing<String>?Source

A comma delimited list of labels to remove when an issue or pull request becomes stale.

Default if unspecified: ""
link

`labels-to-remove-when-stale`: String?Source

A comma delimited list of labels to remove when an issue or pull request becomes stale.

Default if unspecified: ""

To set as a Listing, use labels-to-remove-when-stale-list.
link

hidden

`labels-to-remove-when-unstale-list`: Listing<String>?Source

A comma delimited list of labels to remove when an issue or pull request becomes unstale.

Default if unspecified: ""
link

`labels-to-remove-when-unstale`: String?Source

A comma delimited list of labels to remove when an issue or pull request becomes unstale.

Default if unspecified: ""

To set as a Listing, use labels-to-remove-when-unstale-list.
link

`ignore-updates`: Boolean?Source

Any update (update/comment) can reset the stale idle time on the issues and pull requests.

Default if unspecified: "false"
link

`ignore-issue-updates`: Boolean?Source

Any update (update/comment) can reset the stale idle time on the issues. Override "ignore-updates" option regarding only the issues.

Default if unspecified: ""
link

`ignore-pr-updates`: Boolean?Source

Any update (update/comment) can reset the stale idle time on the pull requests. Override "ignore-updates" option regarding only the pull requests.

Default if unspecified: ""
link

`include-only-assigned`: Boolean?Source

Only the issues or the pull requests with an assignee will be marked as stale automatically.

Default if unspecified: "false"

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.