https://github.com/probot/stale-action
Just like the Stale app, but for Actions!
https://github.com/probot/stale-action
Last synced: 9 months ago
JSON representation
Just like the Stale app, but for Actions!
- Host: GitHub
- URL: https://github.com/probot/stale-action
- Owner: probot
- Archived: true
- Created: 2019-02-27T04:52:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-27T17:15:52.000Z (over 6 years ago)
- Last Synced: 2024-09-22T12:33:09.436Z (over 1 year ago)
- Language: JavaScript
- Size: 977 KB
- Stars: 18
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 🚫Deprecated
This action was made for a pre-release version of Actions. Please use the official Stale action located at [https://github.com/actions/stale](https://github.com/actions/stale)
# Stale-Action
This action is adapted from Probot's [Stale app](https://github.com/probot/stale), built by [@bkeepers](https://github.com/bkeepers), which itself was onspired by @parkr's [auto-reply](https://github.com/parkr/auto-reply#optional-mark-and-sweep-stale-issues) bot that runs @jekyllbot.
It uses [Actions-Toolkit](https://github.com/JasonEtco/actions-toolkit) by [@JasonEtco](https://github.com/JasonEtco) and is built to be run by either a `schedule()` or `repository_dispatch` trigger, allowing you to customize how often to scan for stale content.
## Usage
1. Create `.github/stale.yml` based on the following template.
2. Create a `main.workflow` based off the [`example.workflow`](./example.workflow) in this repository, which will start a scan in response to a [`schedule`](https://developer.github.com/actions/managing-workflows/workflow-configuration-options/#example-scheduled-workflow-block) event. This will schedule as can of your repository however often you specify using [CRON syntax](https://developer.github.com/actions/managing-workflows/creating-and-cancelling-a-workflow/#scheduling-a-workflow). The default schedule in the example will run every day at 12:00AM UTC `(0 0 * * *)`, but we recommend you run this at a time that's conveninet for you. The Actions UI will show the next two scheduled runs to help you gain confidence that the syntax translates to a good schedule.
A `.github/stale.yml` file is required to enable the plugin. The file can be empty, or it can override any of these default settings:
```yml
# Configuration for probot-stale - https://github.com/probot/stale
# Number of days of inactivity before an Issue or Pull Request becomes stale
daysUntilStale: 60
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
daysUntilClose: 7
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
exemptLabels:
- pinned
- security
- "[Status] Maybe Later"
# Set to true to ignore issues in a project (defaults to false)
exemptProjects: false
# Set to true to ignore issues in a milestone (defaults to false)
exemptMilestones: false
# Set to true to ignore issues with an assignee (defaults to false)
exemptAssignees: false
# Label to use when marking as stale
staleLabel: wontfix
# Comment to post when marking as stale. Set to `false` to disable
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Comment to post when removing the stale label.
# unmarkComment: >
# Your comment here.
# Comment to post when closing a stale Issue or Pull Request.
# closeComment: >
# Your comment here.
# Limit the number of actions per hour, from 1-30. Default is 30
limitPerRun: 30
# Limit to only `issues` or `pulls`
# only: issues
# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
# pulls:
# daysUntilStale: 30
# markComment: >
# This pull request has been automatically marked as stale because it has not had
# recent activity. It will be closed if no further activity occurs. Thank you
# for your contributions.
# issues:
# exemptLabels:
# - confirmed
```
### YAML Validation
Thanks to the ability to integrate an Action with [Check Runs](https://developer.github.com/v3/checks/runs/), this also makes use of [Joi](https://github.com/hapijs/joi) and [line-column](https://github.com/io-monad/line-column) to validate your YAML file against the [schema](./lib/schema.js). If one of the values in your `stale.yml` values is invalid, you should get an annotation on the commit that looks something like this:
Right now it will only send annotations for values that don't match the schema. If you have bad YAML syntax, the config will fail to load and you should see relevant errors in the Actions logs.
### Creating a `.workflow` file
The `main.workflow` file contains multiple `on` events. The main one that triggers a scan for stale content is `on = "repository_dispatch"`. The others are events that listen for activity on issues and pull requests to unmark them if they were previously marked as stale.
```hcl
workflow "Run Stale!" {
on = "schedule(0 0 * * *)"
resolves = ["probot/stale-action"]
}
action "probot/stale-action" {
uses = "probot/stale-action@master"
secrets = ["GITHUB_TOKEN"]
}
workflow "On issue comments" {
on = "issue_comment"
resolves = ["probot/stale-action - issue_comment"]
}
action "probot/stale-action - issue_comment" {
uses = "probot/stale-action@master"
secrets = ["GITHUB_TOKEN"]
}
workflow "On pull request" {
on = "pull_request"
resolves = ["probot/stale-action - PR"]
}
action "probot/stale-action - PR" {
uses = "probot/stale-action@master"
secrets = ["GITHUB_TOKEN"]
}
```
## Using with `repository_dispatch`
If needed, the scan can also be triggered manually with a [`repository_dispatch`](https://developer.github.com/actions/managing-workflows/triggering-a-repositorydispatch-webhook/) event. An example with `curl` would look something like this, and requires a token with write access to the repo you want to scan (a `stale.yml` still needs to be present in the repository):
```sh
curl -X POST https://api.github.com/repos/:owner/:repo/dispatches \
-H 'Accept: application/vnd.github.everest-preview+json'
-H 'Authorization: Bearer ' \
-H 'Content-Type: application/json' \
-d '{ "event_type": "stale" }'
```
## License
[ISC](LICENSE) Copyright © 2019 Tommy Byrd