mirror of
https://github.com/actions/stale.git
synced 2025-12-25 09:58:16 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
be24587b3c |
9
.github/dependabot.yml
vendored
9
.github/dependabot.yml
vendored
@@ -4,11 +4,6 @@ updates:
|
|||||||
- package-ecosystem: 'npm'
|
- package-ecosystem: 'npm'
|
||||||
# Look for `package.json` and `lock` files in the `root` directory
|
# Look for `package.json` and `lock` files in the `root` directory
|
||||||
directory: '/'
|
directory: '/'
|
||||||
# Check the npm registry for updates once a week (Monday)
|
# Check the npm registry for updates every day (weekdays)
|
||||||
schedule:
|
schedule:
|
||||||
interval: 'weekly'
|
interval: 'daily'
|
||||||
|
|
||||||
- package-ecosystem: 'github-actions'
|
|
||||||
directory: '/'
|
|
||||||
schedule:
|
|
||||||
interval: 'weekly'
|
|
||||||
|
|||||||
53
.github/workflows/check-dist.yml
vendored
53
.github/workflows/check-dist.yml
vendored
@@ -1,53 +0,0 @@
|
|||||||
# `dist/index.js` is a special file in Actions.
|
|
||||||
# When you reference an action with `uses:` in a workflow,
|
|
||||||
# `index.js` is the code that will run.
|
|
||||||
# For our project, we generate this file through a build process from other source files.
|
|
||||||
# We need to make sure the checked-in `index.js` actually matches what we expect it to be.
|
|
||||||
name: Check dist/
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths-ignore:
|
|
||||||
- '**.md'
|
|
||||||
pull_request:
|
|
||||||
paths-ignore:
|
|
||||||
- '**.md'
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
check-dist:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Set Node.js 16.x
|
|
||||||
uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: 16.x
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Rebuild the dist/ directory
|
|
||||||
run: |
|
|
||||||
npm run build
|
|
||||||
npm run pack
|
|
||||||
|
|
||||||
- name: Compare the expected and actual dist/ directories
|
|
||||||
run: |
|
|
||||||
if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
|
|
||||||
echo "Detected uncommitted changes after build. See status below:"
|
|
||||||
git diff
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
id: diff
|
|
||||||
|
|
||||||
# If index.js was different than expected, upload the expected version as an artifact
|
|
||||||
- uses: actions/upload-artifact@v3
|
|
||||||
if: ${{ failure() && steps.diff.conclusion == 'failure' }}
|
|
||||||
with:
|
|
||||||
name: dist
|
|
||||||
path: dist/
|
|
||||||
8
.github/workflows/codeql.yml
vendored
8
.github/workflows/codeql.yml
vendored
@@ -13,13 +13,13 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
- name: Initialize CodeQL
|
- name: Initialize CodeQL
|
||||||
uses: github/codeql-action/init@v2
|
uses: github/codeql-action/init@v1
|
||||||
|
|
||||||
- name: Autobuild
|
- name: Autobuild
|
||||||
uses: github/codeql-action/autobuild@v2
|
uses: github/codeql-action/autobuild@v1
|
||||||
|
|
||||||
- name: Perform CodeQL Analysis
|
- name: Perform CodeQL Analysis
|
||||||
uses: github/codeql-action/analyze@v2
|
uses: github/codeql-action/analyze@v1
|
||||||
|
|||||||
6
.github/workflows/test.yml
vendored
6
.github/workflows/test.yml
vendored
@@ -10,14 +10,14 @@ jobs:
|
|||||||
build: # make sure build/ci work properly
|
build: # make sure build/ci work properly
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v2
|
||||||
- run: |
|
- run: |
|
||||||
npm ci
|
npm ci
|
||||||
npm run all:ci
|
npm run all
|
||||||
test: # make sure the action works on a clean machine without building
|
test: # make sure the action works on a clean machine without building
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v2
|
||||||
- uses: ./
|
- uses: ./
|
||||||
id: stale
|
id: stale
|
||||||
with:
|
with:
|
||||||
|
|||||||
39
CHANGELOG.md
39
CHANGELOG.md
@@ -1,39 +1,24 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
Starting in version 4.0.0 we will maintain a changelog
|
||||||
# [6.0.0]
|
|
||||||
|
|
||||||
:warning: Breaking change :warning:
|
|
||||||
|
|
||||||
Issues/PRs default `close-issue-reason` is now `not_planned`([#789](https://github.com/actions/stale/issues/789))
|
|
||||||
|
|
||||||
# [5.1.0]
|
|
||||||
|
|
||||||
[Don't process stale issues right after they're marked stale](https://github.com/actions/stale/issues/696)
|
|
||||||
[Add close-issue-reason option][#764](https://github.com/actions/stale/pull/764)[#772](https://github.com/actions/stale/pull/772)
|
|
||||||
Various dependabot/dependency updates
|
|
||||||
|
|
||||||
## [4.1.0](https://github.com/actions/stale/compare/v3.0.19...v4.1.0) (2021-07-14)
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- [Ability to exempt draft PRs](https://github.com/actions/stale/commit/9912fa74d1c01b5d6187793d97441019cbe325d0)
|
|
||||||
|
|
||||||
## [4.0.0](https://github.com/actions/stale/compare/v3.0.19...v4.0.0) (2021-07-14)
|
## [4.0.0](https://github.com/actions/stale/compare/v3.0.19...v4.0.0) (2021-07-14)
|
||||||
|
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- **options:** simplify config by removing skip stale message options ([#457](https://github.com/actions/stale/issues/457)) ([6ec637d](https://github.com/actions/stale/commit/6ec637d238067ab8cc96c9289dcdac280bbd3f4a)), closes [#405](https://github.com/actions/stale/issues/405) [#455](https://github.com/actions/stale/issues/455)
|
* **options:** simplify config by removing skip stale message options ([#457](https://github.com/actions/stale/issues/457)) ([6ec637d](https://github.com/actions/stale/commit/6ec637d238067ab8cc96c9289dcdac280bbd3f4a)), closes [#405](https://github.com/actions/stale/issues/405) [#455](https://github.com/actions/stale/issues/455)
|
||||||
- **output:** print output parameters ([#458](https://github.com/actions/stale/issues/458)) ([3e6d35b](https://github.com/actions/stale/commit/3e6d35b685f0b2fa1a69be893fa07d3d85e05ee0))
|
* **output:** print output parameters ([#458](https://github.com/actions/stale/issues/458)) ([3e6d35b](https://github.com/actions/stale/commit/3e6d35b685f0b2fa1a69be893fa07d3d85e05ee0))
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|
||||||
- **dry-run:** forbid mutations in dry-run ([#500](https://github.com/actions/stale/issues/500)) ([f1017f3](https://github.com/actions/stale/commit/f1017f33dd159ea51366375120c3e6981d7c3097)), closes [#499](https://github.com/actions/stale/issues/499)
|
* **dry-run:** forbid mutations in dry-run ([#500](https://github.com/actions/stale/issues/500)) ([f1017f3](https://github.com/actions/stale/commit/f1017f33dd159ea51366375120c3e6981d7c3097)), closes [#499](https://github.com/actions/stale/issues/499)
|
||||||
- **logs:** coloured logs ([#465](https://github.com/actions/stale/issues/465)) ([5fbbfba](https://github.com/actions/stale/commit/5fbbfba142860ea6512549e96e36e3540c314132))
|
* **logs:** coloured logs ([#465](https://github.com/actions/stale/issues/465)) ([5fbbfba](https://github.com/actions/stale/commit/5fbbfba142860ea6512549e96e36e3540c314132))
|
||||||
- **operations:** fail fast the current batch to respect the operations limit ([#474](https://github.com/actions/stale/issues/474)) ([5f6f311](https://github.com/actions/stale/commit/5f6f311ca6aa75babadfc7bac6edf5d85fa3f35d)), closes [#466](https://github.com/actions/stale/issues/466)
|
* **operations:** fail fast the current batch to respect the operations limit ([#474](https://github.com/actions/stale/issues/474)) ([5f6f311](https://github.com/actions/stale/commit/5f6f311ca6aa75babadfc7bac6edf5d85fa3f35d)), closes [#466](https://github.com/actions/stale/issues/466)
|
||||||
- **label comparison**: make label comparison case insensitive [#517](https://github.com/actions/stale/pull/517), closes [#516](https://github.com/actions/stale/pull/516)
|
* **label comparison**: make label comparison case insensitive [#517](https://github.com/actions/stale/pull/517), closes [#516](https://github.com/actions/stale/pull/516)
|
||||||
- **filtering comments by actor could have strange behavior**: "stale" comments are now detected based on if the message is the stale message not _who_ made the comment([#519](https://github.com/actions/stale/pull/519)), fixes [#441](https://github.com/actions/stale/pull/441), [#509](https://github.com/actions/stale/pull/509), [#518](https://github.com/actions/stale/pull/518)
|
* **filtering comments by actor could have strange behavior**: "stale" comments are now detected based on if the message is the stale message not _who_ made the comment([#519](https://github.com/actions/stale/pull/519)), fixes [#441](https://github.com/actions/stale/pull/441), [#509](https://github.com/actions/stale/pull/509), [#518](https://github.com/actions/stale/pull/518)
|
||||||
|
|
||||||
### Breaking Changes
|
### Breaking Changes
|
||||||
|
|
||||||
- The options `skip-stale-issue-message` and `skip-stale-pr-message` were removed. Instead, setting the options `stale-issue-message` and `stale-pr-message` will be enough to let the stale workflow add a comment. If the options are unset, a comment will not be added which was the equivalent of setting `skip-stale-issue-message` to `true`.
|
* The options `skip-stale-issue-message` and `skip-stale-pr-message` were removed. Instead, setting the options `stale-issue-message` and `stale-pr-message` will be enough to let the stale workflow add a comment. If the options are unset, a comment will not be added which was the equivalent of setting `skip-stale-issue-message` to `true`.
|
||||||
- The `operations-per-run` option will be more effective. After migrating, you could face a failed-fast process workflow if you let the default value (30) or set it to a small number. In that case, you will see a warning at the end of the logs (if enabled) indicating that the workflow was stopped sooner to avoid consuming too much API calls. In most cases, you can just increase this limit to make sure to process everything in a single run.
|
* The `operations-per-run` option will be more effective. After migrating, you could face a failed-fast process workflow if you let the default value (30) or set it to a small number. In that case, you will see a warning at the end of the logs (if enabled) indicating that the workflow was stopped sooner to avoid consuming too much API calls. In most cases, you can just increase this limit to make sure to process everything in a single run.
|
||||||
|
|||||||
@@ -46,13 +46,6 @@ Build, lint, package and test everything.
|
|||||||
$ npm run all
|
$ npm run all
|
||||||
```
|
```
|
||||||
|
|
||||||
IMPORTANT:
|
|
||||||
Be sure to commit the result of:
|
|
||||||
```bash
|
|
||||||
$ npm run pack
|
|
||||||
```
|
|
||||||
Otherwise PR checks will fail.
|
|
||||||
|
|
||||||
# Release
|
# Release
|
||||||
|
|
||||||
Based on [standard-version](https://github.com/conventional-changelog/standard-version).
|
Based on [standard-version](https://github.com/conventional-changelog/standard-version).
|
||||||
|
|||||||
193
README.md
193
README.md
@@ -2,21 +2,20 @@
|
|||||||
|
|
||||||
Warns and then closes issues and PRs that have had no activity for a specified amount of time.
|
Warns and then closes issues and PRs that have had no activity for a specified amount of time.
|
||||||
|
|
||||||
The configuration must be on the default branch and the default values will:
|
The default configuration will:
|
||||||
|
|
||||||
- Add a label "Stale" on issues and pull requests after 60 days of inactivity and comment on them
|
- Add a label "Stale" on issues and pull requests after 60 days of inactivity
|
||||||
- Close the stale issues and pull requests after 7 days of inactivity
|
- Close the stale issues and pull requests after 7 days of inactivity
|
||||||
- If an update/comment occur on stale issues or pull requests, the stale label will be removed and the timer will restart
|
- If an update/comment occur on stale issues or pull requests, the stale label will be removed and the timer will restart
|
||||||
|
|
||||||
## Recommended permissions
|
## Recommended permissions
|
||||||
|
|
||||||
For the execution of this action, it must be able to fetch all issues and pull requests from your repository.
|
For the execution of this action, it must be able to fetch all issues and pull requests from your repository.
|
||||||
In addition, based on the provided configuration, the action could require more permission(s) (e.g.: add label, remove label, comment, close, delete branch, etc.).
|
In addition, based on the provided configuration, the action could require more permission(s) (e.g.: add label, remove label, comment, close, etc.).
|
||||||
This can be achieved with the following [configuration in the action](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions) if the permissions are restricted:
|
This can be achieved with the following [configuration in the action](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions) if the permissions are restricted:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
permissions:
|
permissions:
|
||||||
contents: write # only for delete-branch option
|
|
||||||
issues: write
|
issues: write
|
||||||
pull-requests: write
|
pull-requests: write
|
||||||
```
|
```
|
||||||
@@ -29,67 +28,61 @@ You can find more information about the required permissions under the correspon
|
|||||||
|
|
||||||
Every argument is optional.
|
Every argument is optional.
|
||||||
|
|
||||||
| Input | Description | Default |
|
| Input | Description | Default |
|
||||||
| ------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------- |
|
| ------------------------------------------------------------------- | ------------------------------------------------------------------------ | --------------------- |
|
||||||
| [repo-token](#repo-token) | PAT for GitHub API authentication | `${{ github.token }}` |
|
| [repo-token](#repo-token) | PAT for GitHub API authentication | `${{ github.token }}` |
|
||||||
| [days-before-stale](#days-before-stale) | Idle number of days before marking issues/PRs stale | `60` |
|
| [days-before-stale](#days-before-stale) | Idle number of days before marking issues/PRs stale | `60` |
|
||||||
| [days-before-issue-stale](#days-before-issue-stale) | Override [days-before-stale](#days-before-stale) for issues only | |
|
| [days-before-issue-stale](#days-before-issue-stale) | Override [days-before-stale](#days-before-stale) for issues only | |
|
||||||
| [days-before-pr-stale](#days-before-pr-stale) | Override [days-before-stale](#days-before-stale) for PRs only | |
|
| [days-before-pr-stale](#days-before-pr-stale) | Override [days-before-stale](#days-before-stale) for PRs only | |
|
||||||
| [days-before-close](#days-before-close) | Idle number of days before closing stale issues/PRs | `7` |
|
| [days-before-close](#days-before-close) | Idle number of days before closing stale issues/PRs | `7` |
|
||||||
| [days-before-issue-close](#days-before-issue-close) | Override [days-before-close](#days-before-close) for issues only | |
|
| [days-before-issue-close](#days-before-issue-close) | Override [days-before-close](#days-before-close) for issues only | |
|
||||||
| [days-before-pr-close](#days-before-pr-close) | Override [days-before-close](#days-before-close) for PRs only | |
|
| [days-before-pr-close](#days-before-pr-close) | Override [days-before-close](#days-before-close) for PRs only | |
|
||||||
| [stale-issue-message](#stale-issue-message) | Comment on the staled issues | |
|
| [stale-issue-message](#stale-issue-message) | Comment on the staled issues | |
|
||||||
| [stale-pr-message](#stale-pr-message) | Comment on the staled PRs | |
|
| [stale-pr-message](#stale-pr-message) | Comment on the staled PRs | |
|
||||||
| [close-issue-message](#close-issue-message) | Comment on the staled issues while closed | |
|
| [close-issue-message](#close-issue-message) | Comment on the staled issues while closed | |
|
||||||
| [close-pr-message](#close-pr-message) | Comment on the staled PRs while closed | |
|
| [close-pr-message](#close-pr-message) | Comment on the staled PRs while closed | |
|
||||||
| [stale-issue-label](#stale-issue-label) | Label to apply on staled issues | `Stale` |
|
| [stale-issue-label](#stale-issue-label) | Label to apply on staled issues | `Stale` |
|
||||||
| [close-issue-label](#close-issue-label) | Label to apply on closed issues | |
|
| [close-issue-label](#close-issue-label) | Label to apply on closed issues | |
|
||||||
| [close-issue-reason](#close-issue-reason) | Reason to use when closing issues | `not_planned` |
|
| [stale-pr-label](#stale-pr-label) | Label to apply on staled PRs | `Stale` |
|
||||||
| [stale-pr-label](#stale-pr-label) | Label to apply on staled PRs | `Stale` |
|
| [close-pr-label](#close-pr-label) | Label to apply on closed PRs | |
|
||||||
| [close-pr-label](#close-pr-label) | Label to apply on closed PRs | |
|
| [exempt-issue-labels](#exempt-issue-labels) | Labels on issues exempted from stale | |
|
||||||
| [exempt-issue-labels](#exempt-issue-labels) | Labels on issues exempted from stale | |
|
| [exempt-pr-labels](#exempt-pr-labels) | Labels on PRs exempted from stale | |
|
||||||
| [exempt-pr-labels](#exempt-pr-labels) | Labels on PRs exempted from stale | |
|
| [only-labels](#only-labels) | Only issues/PRs with ALL these labels are checked | |
|
||||||
| [only-labels](#only-labels) | Only issues/PRs with ALL these labels are checked | |
|
| [only-issue-labels](#only-issue-labels) | Only issues with ALL these labels are checked | |
|
||||||
| [only-issue-labels](#only-issue-labels) | Override [only-labels](#only-labels) for issues only | |
|
| [only-pr-labels](#only-pr-labels) | Only PRs with ALL these labels are checked | |
|
||||||
| [only-pr-labels](#only-pr-labels) | Override [only-labels](#only-labels) for PRs only | |
|
| [any-of-labels](#any-of-labels) | Only issues/PRs with ANY of these labels are checked | |
|
||||||
| [any-of-labels](#any-of-labels) | Only issues/PRs with ANY of these labels are checked | |
|
| [any-of-issue-labels](#any-of-issue-labels) | Only issues with ANY of these labels are checked | |
|
||||||
| [any-of-issue-labels](#any-of-issue-labels) | Override [any-of-labels](#any-of-labels) for issues only | |
|
| [any-of-pr-labels](#any-of-pr-labels) | Only PRs with ANY of these labels are checked | |
|
||||||
| [any-of-pr-labels](#any-of-pr-labels) | Override [any-of-labels](#any-of-labels) for PRs only | |
|
| [operations-per-run](#operations-per-run) | Max number of operations per run | `30` |
|
||||||
| [operations-per-run](#operations-per-run) | Max number of operations per run | `30` |
|
| [remove-stale-when-updated](#remove-stale-when-updated) | Remove stale label from issues/PRs on updates/comments | `true` |
|
||||||
| [remove-stale-when-updated](#remove-stale-when-updated) | Remove stale label from issues/PRs on updates | `true` |
|
| [remove-issue-stale-when-updated](#remove-issue-stale-when-updated) | Remove stale label from issues on updates/comments | |
|
||||||
| [remove-issue-stale-when-updated](#remove-issue-stale-when-updated) | Remove stale label from issues on updates/comments | |
|
| [remove-pr-stale-when-updated](#remove-pr-stale-when-updated) | Remove stale label from PRs on updates/comments | |
|
||||||
| [remove-pr-stale-when-updated](#remove-pr-stale-when-updated) | Remove stale label from PRs on updates/comments | |
|
| [labels-to-add-when-unstale](#labels-to-add-when-unstale) | Add specified labels from issues/PRs when they become unstale | |
|
||||||
| [labels-to-add-when-unstale](#labels-to-add-when-unstale) | Add specified labels from issues/PRs when they become unstale | |
|
| [labels-to-remove-when-unstale](#labels-to-remove-when-unstale) | Remove specified labels from issues/PRs when they become unstale | |
|
||||||
| [labels-to-remove-when-unstale](#labels-to-remove-when-unstale) | Remove specified labels from issues/PRs when they become unstale | |
|
| [debug-only](#debug-only) | Dry-run | `false` |
|
||||||
| [debug-only](#debug-only) | Dry-run | `false` |
|
| [ascending](#ascending) | Order to get issues/PRs | `false` |
|
||||||
| [ascending](#ascending) | Order to get issues/PRs | `false` |
|
| [start-date](#start-date) | Skip stale action for issues/PRs created before it | |
|
||||||
| [start-date](#start-date) | Skip stale action for issues/PRs created before it | |
|
| [delete-branch](#delete-branch) | Delete branch after closing a stale PR | `false` |
|
||||||
| [delete-branch](#delete-branch) | Delete branch after closing a stale PR | `false` |
|
| [exempt-milestones](#exempt-milestones) | Milestones on issues/PRs exempted from stale | |
|
||||||
| [exempt-milestones](#exempt-milestones) | Milestones on issues/PRs exempted from stale | |
|
| [exempt-issue-milestones](#exempt-issue-milestones) | Override [exempt-milestones](#exempt-milestones) for issues only | |
|
||||||
| [exempt-issue-milestones](#exempt-issue-milestones) | Override [exempt-milestones](#exempt-milestones) for issues only | |
|
| [exempt-pr-milestones](#exempt-pr-milestones) | Override [exempt-milestones](#exempt-milestones) for PRs only | |
|
||||||
| [exempt-pr-milestones](#exempt-pr-milestones) | Override [exempt-milestones](#exempt-milestones) for PRs only | |
|
| [exempt-all-milestones](#exempt-all-milestones) | Exempt all issues/PRs with milestones from stale | |
|
||||||
| [exempt-all-milestones](#exempt-all-milestones) | Exempt all issues/PRs with milestones from stale | `false` |
|
| [exempt-all-issue-milestones](#exempt-all-issue-milestones) | Override [exempt-all-milestones](#exempt-all-milestones) for issues only | |
|
||||||
| [exempt-all-issue-milestones](#exempt-all-issue-milestones) | Override [exempt-all-milestones](#exempt-all-milestones) for issues only | |
|
| [exempt-all-pr-milestones](#exempt-all-pr-milestones) | Override [exempt-all-milestones](#exempt-all-milestones) for PRs only | |
|
||||||
| [exempt-all-pr-milestones](#exempt-all-pr-milestones) | Override [exempt-all-milestones](#exempt-all-milestones) for PRs only | |
|
| [exempt-assignees](#exempt-assignees) | Assignees on issues/PRs exempted from stale | |
|
||||||
| [exempt-assignees](#exempt-assignees) | Assignees on issues/PRs exempted from stale | |
|
| [exempt-issue-assignees](#exempt-issue-assignees) | Override [exempt-assignees](#exempt-assignees) for issues only | |
|
||||||
| [exempt-issue-assignees](#exempt-issue-assignees) | Override [exempt-assignees](#exempt-assignees) for issues only | |
|
| [exempt-pr-assignees](#exempt-pr-assignees) | Override [exempt-assignees](#exempt-assignees) for PRs only | |
|
||||||
| [exempt-pr-assignees](#exempt-pr-assignees) | Override [exempt-assignees](#exempt-assignees) for PRs only | |
|
| [exempt-all-assignees](#exempt-all-assignees) | Exempt all issues/PRs with assignees from stale | |
|
||||||
| [exempt-all-assignees](#exempt-all-assignees) | Exempt all issues/PRs with assignees from stale | `false` |
|
| [exempt-all-issue-assignees](#exempt-all-issue-assignees) | Override [exempt-all-assignees](#exempt-all-assignees) for issues only | |
|
||||||
| [exempt-all-issue-assignees](#exempt-all-issue-assignees) | Override [exempt-all-assignees](#exempt-all-assignees) for issues only | |
|
| [exempt-all-pr-assignees](#exempt-all-pr-assignees) | Override [exempt-all-assignees](#exempt-all-assignees) for PRs only | |
|
||||||
| [exempt-all-pr-assignees](#exempt-all-pr-assignees) | Override [exempt-all-assignees](#exempt-all-assignees) for PRs only | |
|
| [enable-statistics](#enable-statistics) | Display statistics in the logs | `true` |
|
||||||
| [exempt-draft-pr](#exempt-draft-pr) | Skip the stale action for draft PRs | `false` |
|
|
||||||
| [enable-statistics](#enable-statistics) | Display statistics in the logs | `true` |
|
|
||||||
| [ignore-updates](#ignore-updates) | Any update (update/comment) can reset the stale idle time on the issues/PRs | `false` |
|
|
||||||
| [ignore-issue-updates](#ignore-issue-updates) | Override [ignore-updates](#ignore-updates) for issues only | |
|
|
||||||
| [ignore-pr-updates](#ignore-pr-updates) | Override [ignore-updates](#ignore-updates) for PRs only | |
|
|
||||||
| [include-only-assigned](#include-only-assigned) | Process only assigned issues | `false` |
|
|
||||||
|
|
||||||
### List of output options
|
### List of output options
|
||||||
|
|
||||||
| Output | Description |
|
| Output | Description |
|
||||||
| ----------------- | ------------------------------------------- |
|
| ----------------- | -------------------------------------------- |
|
||||||
| staled-issues-prs | List of all staled issues and pull requests |
|
| staled-issues-prs | List of all staled issues and pull requests. |
|
||||||
| closed-issues-prs | List of all closed issues and pull requests |
|
| closed-issues-prs | List of all closed issues and pull requests. |
|
||||||
|
|
||||||
### Detailed options
|
### Detailed options
|
||||||
|
|
||||||
@@ -103,9 +96,7 @@ Default value: `${{ github.token }}`
|
|||||||
#### days-before-stale
|
#### days-before-stale
|
||||||
|
|
||||||
The idle number of days before marking the issues or the pull requests as stale (by adding a label).
|
The idle number of days before marking the issues or the pull requests as stale (by adding a label).
|
||||||
The issues or the pull requests will be marked as stale if the last update (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) is older than the idle number of days.
|
The issues or the pull requests will be marked as stale if the last update (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) is older than the idle number of days.
|
||||||
It means that any updates made, or any comments added to the issues or to the pull requests will restart the counter of days before marking as stale.
|
|
||||||
However, if you wish to ignore this behaviour so that the creation date (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `created_at`) only matters, you can disable the [ignore-updates](#ignore-updates) option.
|
|
||||||
|
|
||||||
If set to a negative number like `-1`, no issues or pull requests will be marked as stale automatically.
|
If set to a negative number like `-1`, no issues or pull requests will be marked as stale automatically.
|
||||||
In that case, you can still add the stale label manually to mark as stale.
|
In that case, you can still add the stale label manually to mark as stale.
|
||||||
@@ -131,7 +122,6 @@ You can fine tune which issues or pull requests should be marked as stale based
|
|||||||
- [exempt-all-milestones](#exempt-all-milestones)
|
- [exempt-all-milestones](#exempt-all-milestones)
|
||||||
- [exempt-assignees](#exempt-assignees)
|
- [exempt-assignees](#exempt-assignees)
|
||||||
- [exempt-all-assignees](#exempt-all-assignees)
|
- [exempt-all-assignees](#exempt-all-assignees)
|
||||||
- [ignore-updates](#ignore-updates)
|
|
||||||
|
|
||||||
Default value: `60`
|
Default value: `60`
|
||||||
|
|
||||||
@@ -178,7 +168,7 @@ Default value: unset
|
|||||||
|
|
||||||
The message that will be added as a comment to the issues when the stale workflow marks it automatically as stale with a label.
|
The message that will be added as a comment to the issues when the stale workflow marks it automatically as stale with a label.
|
||||||
|
|
||||||
You can skip the comment sending by passing an empty string.
|
You can skip the comment sending by omitting the option or by passing an empty string.
|
||||||
|
|
||||||
Default value: unset
|
Default value: unset
|
||||||
Required Permission: `issues: write`
|
Required Permission: `issues: write`
|
||||||
@@ -187,7 +177,7 @@ Required Permission: `issues: write`
|
|||||||
|
|
||||||
The message that will be added as a comment to the pull requests when the stale workflow marks it automatically as stale with a label.
|
The message that will be added as a comment to the pull requests when the stale workflow marks it automatically as stale with a label.
|
||||||
|
|
||||||
You can skip the comment sending by passing an empty string.
|
You can skip the comment sending by omitting the option or by passing an empty string.
|
||||||
|
|
||||||
Default value: unset
|
Default value: unset
|
||||||
Required Permission: `pull-requests: write`
|
Required Permission: `pull-requests: write`
|
||||||
@@ -222,12 +212,6 @@ It will be automatically removed if the issues are no longer closed nor locked.
|
|||||||
Default value: unset
|
Default value: unset
|
||||||
Required Permission: `issues: write`
|
Required Permission: `issues: write`
|
||||||
|
|
||||||
#### close-issue-reason
|
|
||||||
|
|
||||||
Specify the [reason](https://github.blog/changelog/2022-05-19-the-new-github-issues-may-19th-update/) used when closing issues. Valid values are `completed` and `not_planned`.
|
|
||||||
|
|
||||||
Default value: `not_planned`
|
|
||||||
|
|
||||||
#### stale-pr-label
|
#### stale-pr-label
|
||||||
|
|
||||||
The label that will be added to the pull requests when automatically marked as stale.
|
The label that will be added to the pull requests when automatically marked as stale.
|
||||||
@@ -398,7 +382,7 @@ Default value: unset
|
|||||||
If set to `true`, the stale workflow will automatically delete the GitHub branches related to the pull requests automatically closed by the stale workflow.
|
If set to `true`, the stale workflow will automatically delete the GitHub branches related to the pull requests automatically closed by the stale workflow.
|
||||||
|
|
||||||
Default value: `false`
|
Default value: `false`
|
||||||
Required Permission: `pull-requests: write` and `contents: write`
|
Required Permission: `pull-requests: write`
|
||||||
|
|
||||||
#### exempt-milestones
|
#### exempt-milestones
|
||||||
|
|
||||||
@@ -482,14 +466,6 @@ Override [exempt-all-assignees](#exempt-all-assignees) but only to exempt the pu
|
|||||||
|
|
||||||
Default value: unset
|
Default value: unset
|
||||||
|
|
||||||
#### exempt-draft-pr
|
|
||||||
|
|
||||||
If set to `true`, the pull requests currently in draft will not be marked as stale automatically.
|
|
||||||
⚠️ This option consume one operation per pull request to process because we need to fetch the pull request with the GitHub API to know if it's a draft one or not.
|
|
||||||
|
|
||||||
Default value: `false`
|
|
||||||
Required Permission: `pull-requests: read`
|
|
||||||
|
|
||||||
#### enable-statistics
|
#### enable-statistics
|
||||||
|
|
||||||
Collects and display statistics at the end of the stale workflow logs to get a summary of what happened during the run.
|
Collects and display statistics at the end of the stale workflow logs to get a summary of what happened during the run.
|
||||||
@@ -497,33 +473,6 @@ This option is only useful if the debug output secret `ACTIONS_STEP_DEBUG` is se
|
|||||||
|
|
||||||
Default value: `true`
|
Default value: `true`
|
||||||
|
|
||||||
#### ignore-updates
|
|
||||||
|
|
||||||
The option [days-before-stale](#days-before-stale) will define the number of days before considering the issues or the pull requests as stale.
|
|
||||||
In most cases, the purpose of this action is to only stale when necessary so if any update occurs or if a comment is added to them, the counter will restart.
|
|
||||||
Nonetheless, if you don't care about this, and you prefer to stick to this number of days no matter the update, you can enable this option.
|
|
||||||
Instead of comparing the number of days based on the [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`, it will be based on the [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `created_at`.
|
|
||||||
|
|
||||||
Default value: `false`
|
|
||||||
|
|
||||||
#### ignore-issue-updates
|
|
||||||
|
|
||||||
Useful to override [ignore-updates](#ignore-updates) but only to ignore the updates for the issues.
|
|
||||||
|
|
||||||
Default value: unset
|
|
||||||
|
|
||||||
#### ignore-pr-updates
|
|
||||||
|
|
||||||
Useful to override [ignore-updates](#ignore-updates) but only to ignore the updates for the pull requests.
|
|
||||||
|
|
||||||
Default value: unset
|
|
||||||
|
|
||||||
#### include-only-assigned
|
|
||||||
|
|
||||||
If set to `true`, only the issues or the pull requests with an assignee will be marked as stale automatically.
|
|
||||||
|
|
||||||
Default value: `false`
|
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
See also [action.yml](./action.yml) for a comprehensive list of all the options.
|
See also [action.yml](./action.yml) for a comprehensive list of all the options.
|
||||||
@@ -540,7 +489,7 @@ jobs:
|
|||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6
|
- uses: actions/stale@v4
|
||||||
with:
|
with:
|
||||||
stale-issue-message: 'Message to comment on stale issues. If none provided, will not mark issues stale'
|
stale-issue-message: 'Message to comment on stale issues. If none provided, will not mark issues stale'
|
||||||
stale-pr-message: 'Message to comment on stale PRs. If none provided, will not mark PRs stale'
|
stale-pr-message: 'Message to comment on stale PRs. If none provided, will not mark PRs stale'
|
||||||
@@ -558,7 +507,7 @@ jobs:
|
|||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6
|
- uses: actions/stale@v4
|
||||||
with:
|
with:
|
||||||
stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
|
stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
|
||||||
days-before-stale: 30
|
days-before-stale: 30
|
||||||
@@ -577,7 +526,7 @@ jobs:
|
|||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6
|
- uses: actions/stale@v4
|
||||||
with:
|
with:
|
||||||
stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
|
stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
|
||||||
stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
|
stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
|
||||||
@@ -599,7 +548,7 @@ jobs:
|
|||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6
|
- uses: actions/stale@v4
|
||||||
with:
|
with:
|
||||||
stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
|
stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
|
||||||
stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
|
stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
|
||||||
@@ -623,7 +572,7 @@ jobs:
|
|||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6
|
- uses: actions/stale@v4
|
||||||
with:
|
with:
|
||||||
stale-issue-message: 'Stale issue message'
|
stale-issue-message: 'Stale issue message'
|
||||||
stale-pr-message: 'Stale pull request message'
|
stale-pr-message: 'Stale pull request message'
|
||||||
@@ -646,9 +595,9 @@ jobs:
|
|||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6
|
- uses: actions/stale@v4
|
||||||
with:
|
with:
|
||||||
start-date: '2020-04-18T00:00:00Z' # ISO 8601 or RFC 2822
|
start-date: '2020-18-04T00:00:00Z' # ISO 8601 or RFC 2822
|
||||||
```
|
```
|
||||||
|
|
||||||
Avoid stale for specific milestones:
|
Avoid stale for specific milestones:
|
||||||
@@ -663,7 +612,7 @@ jobs:
|
|||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6
|
- uses: actions/stale@v4
|
||||||
with:
|
with:
|
||||||
exempt-issue-milestones: 'future,alpha,beta'
|
exempt-issue-milestones: 'future,alpha,beta'
|
||||||
exempt-pr-milestones: 'bugfix,improvement'
|
exempt-pr-milestones: 'bugfix,improvement'
|
||||||
@@ -681,7 +630,7 @@ jobs:
|
|||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6
|
- uses: actions/stale@v4
|
||||||
with:
|
with:
|
||||||
exempt-all-pr-milestones: true
|
exempt-all-pr-milestones: true
|
||||||
```
|
```
|
||||||
@@ -698,7 +647,7 @@ jobs:
|
|||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6
|
- uses: actions/stale@v4
|
||||||
with:
|
with:
|
||||||
any-of-labels: 'needs-more-info,needs-demo'
|
any-of-labels: 'needs-more-info,needs-demo'
|
||||||
# You can opt for 'only-labels' instead if your use-case requires all labels
|
# You can opt for 'only-labels' instead if your use-case requires all labels
|
||||||
@@ -717,7 +666,7 @@ jobs:
|
|||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6
|
- uses: actions/stale@v4
|
||||||
with:
|
with:
|
||||||
exempt-issue-assignees: 'marco,polo'
|
exempt-issue-assignees: 'marco,polo'
|
||||||
exempt-pr-assignees: 'marco'
|
exempt-pr-assignees: 'marco'
|
||||||
@@ -735,7 +684,7 @@ jobs:
|
|||||||
stale:
|
stale:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v6
|
- uses: actions/stale@v4
|
||||||
with:
|
with:
|
||||||
exempt-all-pr-assignees: true
|
exempt-all-pr-assignees: true
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import {generateIssue} from './functions/generate-issue';
|
|||||||
let issuesProcessorBuilder: IssuesProcessorBuilder;
|
let issuesProcessorBuilder: IssuesProcessorBuilder;
|
||||||
let issuesProcessor: IssuesProcessorMock;
|
let issuesProcessor: IssuesProcessorMock;
|
||||||
|
|
||||||
describe('any-of-labels options', (): void => {
|
describe('any-of-labels option', (): void => {
|
||||||
beforeEach((): void => {
|
beforeEach((): void => {
|
||||||
issuesProcessorBuilder = new IssuesProcessorBuilder();
|
issuesProcessorBuilder = new IssuesProcessorBuilder();
|
||||||
});
|
});
|
||||||
@@ -1103,7 +1103,7 @@ class IssuesProcessorBuilder {
|
|||||||
issue.updated_at ?? new Date().toDateString(),
|
issue.updated_at ?? new Date().toDateString(),
|
||||||
issue.created_at ?? new Date().toDateString(),
|
issue.created_at ?? new Date().toDateString(),
|
||||||
!!issue.pull_request,
|
!!issue.pull_request,
|
||||||
issue.labels ? issue.labels.map(label => label.name || '') : []
|
issue.labels ? issue.labels.map(label => label.name) : []
|
||||||
)
|
)
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|||||||
@@ -2,21 +2,19 @@ import {Issue} from '../../src/classes/issue';
|
|||||||
import {IssuesProcessor} from '../../src/classes/issues-processor';
|
import {IssuesProcessor} from '../../src/classes/issues-processor';
|
||||||
import {IComment} from '../../src/interfaces/comment';
|
import {IComment} from '../../src/interfaces/comment';
|
||||||
import {IIssuesProcessorOptions} from '../../src/interfaces/issues-processor-options';
|
import {IIssuesProcessorOptions} from '../../src/interfaces/issues-processor-options';
|
||||||
import {IPullRequest} from '../../src/interfaces/pull-request';
|
|
||||||
|
|
||||||
export class IssuesProcessorMock extends IssuesProcessor {
|
export class IssuesProcessorMock extends IssuesProcessor {
|
||||||
constructor(
|
constructor(
|
||||||
options: IIssuesProcessorOptions,
|
options: IIssuesProcessorOptions,
|
||||||
getIssues?: (page: number) => Promise<Issue[]>,
|
getIssues?: (page: number) => Promise<Issue[]>,
|
||||||
listIssueComments?: (
|
listIssueComments?: (
|
||||||
issue: Issue,
|
issueNumber: number,
|
||||||
sinceDate: string
|
sinceDate: string
|
||||||
) => Promise<IComment[]>,
|
) => Promise<IComment[]>,
|
||||||
getLabelCreationDate?: (
|
getLabelCreationDate?: (
|
||||||
issue: Issue,
|
issue: Issue,
|
||||||
label: string
|
label: string
|
||||||
) => Promise<string | undefined>,
|
) => Promise<string | undefined>
|
||||||
getPullRequest?: (issue: Issue) => Promise<IPullRequest | undefined | void>
|
|
||||||
) {
|
) {
|
||||||
super(options);
|
super(options);
|
||||||
|
|
||||||
@@ -31,9 +29,5 @@ export class IssuesProcessorMock extends IssuesProcessor {
|
|||||||
if (getLabelCreationDate) {
|
if (getLabelCreationDate) {
|
||||||
this.getLabelCreationDate = getLabelCreationDate;
|
this.getLabelCreationDate = getLabelCreationDate;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (getPullRequest) {
|
|
||||||
this.getPullRequest = getPullRequest;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,5 @@
|
|||||||
import {IIssuesProcessorOptions} from '../../src/interfaces/issues-processor-options';
|
import {IIssuesProcessorOptions} from '../../src/interfaces/issues-processor-options';
|
||||||
|
|
||||||
// Default options for use in tests.
|
|
||||||
// Mirrors the defaults defined in action.yml
|
|
||||||
export const DefaultProcessorOptions: IIssuesProcessorOptions = Object.freeze({
|
export const DefaultProcessorOptions: IIssuesProcessorOptions = Object.freeze({
|
||||||
repoToken: 'none',
|
repoToken: 'none',
|
||||||
staleIssueMessage: 'This issue is stale',
|
staleIssueMessage: 'This issue is stale',
|
||||||
@@ -48,11 +46,5 @@ export const DefaultProcessorOptions: IIssuesProcessorOptions = Object.freeze({
|
|||||||
exemptAllPrAssignees: undefined,
|
exemptAllPrAssignees: undefined,
|
||||||
enableStatistics: true,
|
enableStatistics: true,
|
||||||
labelsToRemoveWhenUnstale: '',
|
labelsToRemoveWhenUnstale: '',
|
||||||
labelsToAddWhenUnstale: '',
|
labelsToAddWhenUnstale: ''
|
||||||
ignoreUpdates: false,
|
|
||||||
ignoreIssueUpdates: undefined,
|
|
||||||
ignorePrUpdates: undefined,
|
|
||||||
exemptDraftPr: false,
|
|
||||||
closeIssueReason: 'not_planned',
|
|
||||||
includeOnlyAssigned: false
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,139 +0,0 @@
|
|||||||
import {Issue} from '../src/classes/issue';
|
|
||||||
import {IIssue} from '../src/interfaces/issue';
|
|
||||||
import {IIssuesProcessorOptions} from '../src/interfaces/issues-processor-options';
|
|
||||||
import {IPullRequest} from '../src/interfaces/pull-request';
|
|
||||||
import {IssuesProcessorMock} from './classes/issues-processor-mock';
|
|
||||||
import {DefaultProcessorOptions} from './constants/default-processor-options';
|
|
||||||
import {generateIssue} from './functions/generate-issue';
|
|
||||||
|
|
||||||
let issuesProcessorBuilder: IssuesProcessorBuilder;
|
|
||||||
let issuesProcessor: IssuesProcessorMock;
|
|
||||||
|
|
||||||
describe('exempt-draft-pr option', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
issuesProcessorBuilder = new IssuesProcessorBuilder();
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the option "exempt-draft-pr" is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
issuesProcessorBuilder.processDraftPr();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('should stale the pull request', async (): Promise<void> => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issuesProcessor = issuesProcessorBuilder
|
|
||||||
.toStalePrs([
|
|
||||||
{
|
|
||||||
number: 10
|
|
||||||
}
|
|
||||||
])
|
|
||||||
.build();
|
|
||||||
|
|
||||||
await issuesProcessor.processIssues();
|
|
||||||
|
|
||||||
expect(issuesProcessor.staleIssues).toHaveLength(1);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the option "exempt-draft-pr" is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
issuesProcessorBuilder.exemptDraftPr();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('should not stale the pull request', async (): Promise<void> => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issuesProcessor = issuesProcessorBuilder
|
|
||||||
.toStalePrs([
|
|
||||||
{
|
|
||||||
number: 20
|
|
||||||
}
|
|
||||||
])
|
|
||||||
.build();
|
|
||||||
|
|
||||||
await issuesProcessor.processIssues();
|
|
||||||
|
|
||||||
expect(issuesProcessor.staleIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
class IssuesProcessorBuilder {
|
|
||||||
private _options: IIssuesProcessorOptions = {
|
|
||||||
...DefaultProcessorOptions
|
|
||||||
};
|
|
||||||
private _issues: Issue[] = [];
|
|
||||||
|
|
||||||
processDraftPr(): IssuesProcessorBuilder {
|
|
||||||
this._options.exemptDraftPr = false;
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
exemptDraftPr(): IssuesProcessorBuilder {
|
|
||||||
this._options.exemptDraftPr = true;
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
issuesOrPrs(issues: Partial<IIssue>[]): IssuesProcessorBuilder {
|
|
||||||
this._issues = issues.map(
|
|
||||||
(issue: Readonly<Partial<IIssue>>, index: Readonly<number>): Issue =>
|
|
||||||
generateIssue(
|
|
||||||
this._options,
|
|
||||||
issue.number ?? index,
|
|
||||||
issue.title ?? 'dummy-title',
|
|
||||||
issue.updated_at ?? new Date().toDateString(),
|
|
||||||
issue.created_at ?? new Date().toDateString(),
|
|
||||||
!!issue.pull_request,
|
|
||||||
issue.labels ? issue.labels.map(label => label.name || '') : []
|
|
||||||
)
|
|
||||||
);
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
prs(issues: Partial<IIssue>[]): IssuesProcessorBuilder {
|
|
||||||
this.issuesOrPrs(
|
|
||||||
issues.map((issue: Readonly<Partial<IIssue>>): Partial<IIssue> => {
|
|
||||||
return {
|
|
||||||
...issue,
|
|
||||||
pull_request: {key: 'value'}
|
|
||||||
};
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
toStalePrs(issues: Partial<IIssue>[]): IssuesProcessorBuilder {
|
|
||||||
this.prs(
|
|
||||||
issues.map((issue: Readonly<Partial<IIssue>>): Partial<IIssue> => {
|
|
||||||
return {
|
|
||||||
...issue,
|
|
||||||
updated_at: '2020-01-01T17:00:00Z',
|
|
||||||
created_at: '2020-01-01T17:00:00Z'
|
|
||||||
};
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
build(): IssuesProcessorMock {
|
|
||||||
return new IssuesProcessorMock(
|
|
||||||
this._options,
|
|
||||||
async p => (p === 1 ? this._issues : []),
|
|
||||||
async () => [],
|
|
||||||
async () => new Date().toDateString(),
|
|
||||||
async (): Promise<IPullRequest> => {
|
|
||||||
return Promise.resolve({
|
|
||||||
number: 0,
|
|
||||||
draft: true,
|
|
||||||
head: {
|
|
||||||
ref: 'ref'
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
import {Issue} from '../../src/classes/issue';
|
import {Issue} from '../../src/classes/issue';
|
||||||
import {IUserAssignee} from '../../src/interfaces/assignee';
|
import {IAssignee} from '../../src/interfaces/assignee';
|
||||||
import {IIssuesProcessorOptions} from '../../src/interfaces/issues-processor-options';
|
import {IIssuesProcessorOptions} from '../../src/interfaces/issues-processor-options';
|
||||||
import {IsoDateString} from '../../src/types/iso-date-string';
|
import {IsoDateString} from '../../src/types/iso-date-string';
|
||||||
|
|
||||||
@@ -32,10 +32,9 @@ export function generateIssue(
|
|||||||
title: milestone
|
title: milestone
|
||||||
}
|
}
|
||||||
: undefined,
|
: undefined,
|
||||||
assignees: assignees.map((assignee: Readonly<string>): IUserAssignee => {
|
assignees: assignees.map((assignee: Readonly<string>): IAssignee => {
|
||||||
return {
|
return {
|
||||||
login: assignee,
|
login: assignee
|
||||||
type: 'User'
|
|
||||||
};
|
};
|
||||||
})
|
})
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -2282,139 +2282,3 @@ test('processing an issue stale since less than the daysBeforeStale without a st
|
|||||||
expect(processor.deletedBranchIssues).toHaveLength(0);
|
expect(processor.deletedBranchIssues).toHaveLength(0);
|
||||||
expect(processor.closedIssues).toHaveLength(0);
|
expect(processor.closedIssues).toHaveLength(0);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('processing a pull request to be stale with the "stalePrMessage" option set will send a PR comment', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
const opts: IIssuesProcessorOptions = {
|
|
||||||
...DefaultProcessorOptions,
|
|
||||||
stalePrMessage: 'This PR is stale',
|
|
||||||
daysBeforeStale: 10,
|
|
||||||
daysBeforePrStale: 1
|
|
||||||
};
|
|
||||||
const issueDate = new Date();
|
|
||||||
issueDate.setDate(issueDate.getDate() - 2);
|
|
||||||
const TestIssueList: Issue[] = [
|
|
||||||
generateIssue(
|
|
||||||
opts,
|
|
||||||
1,
|
|
||||||
'A pull request with no label and a stale message',
|
|
||||||
issueDate.toDateString(),
|
|
||||||
issueDate.toDateString(),
|
|
||||||
true
|
|
||||||
)
|
|
||||||
];
|
|
||||||
const processor = new IssuesProcessorMock(
|
|
||||||
opts,
|
|
||||||
async p => (p === 1 ? TestIssueList : []),
|
|
||||||
async () => [],
|
|
||||||
async () => new Date().toDateString()
|
|
||||||
);
|
|
||||||
|
|
||||||
// process our fake issue list
|
|
||||||
await processor.processIssues(1);
|
|
||||||
|
|
||||||
expect(processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(processor.statistics?.addedPullRequestsCommentsCount).toStrictEqual(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('processing a pull request to be stale with the "stalePrMessage" option set to empty will not send a PR comment', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
const opts: IIssuesProcessorOptions = {
|
|
||||||
...DefaultProcessorOptions,
|
|
||||||
stalePrMessage: '',
|
|
||||||
daysBeforeStale: 10,
|
|
||||||
daysBeforePrStale: 1
|
|
||||||
};
|
|
||||||
const issueDate = new Date();
|
|
||||||
issueDate.setDate(issueDate.getDate() - 2);
|
|
||||||
const TestIssueList: Issue[] = [
|
|
||||||
generateIssue(
|
|
||||||
opts,
|
|
||||||
1,
|
|
||||||
'A pull request with no label and a stale message',
|
|
||||||
issueDate.toDateString(),
|
|
||||||
issueDate.toDateString(),
|
|
||||||
true
|
|
||||||
)
|
|
||||||
];
|
|
||||||
const processor = new IssuesProcessorMock(
|
|
||||||
opts,
|
|
||||||
async p => (p === 1 ? TestIssueList : []),
|
|
||||||
async () => [],
|
|
||||||
async () => new Date().toDateString()
|
|
||||||
);
|
|
||||||
|
|
||||||
// process our fake issue list
|
|
||||||
await processor.processIssues(1);
|
|
||||||
|
|
||||||
expect(processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(processor.statistics?.addedPullRequestsCommentsCount).toStrictEqual(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('processing an issue with the "includeOnlyAssigned" option and nonempty assignee list will stale the issue', async () => {
|
|
||||||
const issueDate = new Date();
|
|
||||||
issueDate.setDate(issueDate.getDate() - 2);
|
|
||||||
|
|
||||||
const opts: IIssuesProcessorOptions = {
|
|
||||||
...DefaultProcessorOptions,
|
|
||||||
staleIssueLabel: 'This issue is stale',
|
|
||||||
includeOnlyAssigned: true
|
|
||||||
};
|
|
||||||
|
|
||||||
const TestIssueList: Issue[] = [
|
|
||||||
generateIssue(
|
|
||||||
opts,
|
|
||||||
1,
|
|
||||||
'An issue with no label',
|
|
||||||
issueDate.toDateString(),
|
|
||||||
issueDate.toDateString(),
|
|
||||||
false,
|
|
||||||
[],
|
|
||||||
false,
|
|
||||||
false,
|
|
||||||
undefined,
|
|
||||||
['assignee1']
|
|
||||||
)
|
|
||||||
];
|
|
||||||
const processor = new IssuesProcessorMock(
|
|
||||||
opts,
|
|
||||||
async p => (p === 1 ? TestIssueList : []),
|
|
||||||
async () => [],
|
|
||||||
async () => new Date().toDateString()
|
|
||||||
);
|
|
||||||
|
|
||||||
// process our fake issue list
|
|
||||||
await processor.processIssues(1);
|
|
||||||
|
|
||||||
expect(processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(processor.closedIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('processing an issue with the "includeOnlyAssigned" option set and no assignees will not stale the issue', async () => {
|
|
||||||
const issueDate = new Date();
|
|
||||||
issueDate.setDate(issueDate.getDate() - 2);
|
|
||||||
|
|
||||||
const opts: IIssuesProcessorOptions = {
|
|
||||||
...DefaultProcessorOptions,
|
|
||||||
staleIssueLabel: 'This issue is stale',
|
|
||||||
includeOnlyAssigned: true
|
|
||||||
};
|
|
||||||
|
|
||||||
const TestIssueList: Issue[] = [
|
|
||||||
generateIssue(opts, 1, 'An issue with no label', issueDate.toDateString())
|
|
||||||
];
|
|
||||||
const processor = new IssuesProcessorMock(
|
|
||||||
opts,
|
|
||||||
async p => (p === 1 ? TestIssueList : []),
|
|
||||||
async () => [],
|
|
||||||
async () => new Date().toDateString()
|
|
||||||
);
|
|
||||||
|
|
||||||
// process our fake issue list
|
|
||||||
await processor.processIssues(1);
|
|
||||||
|
|
||||||
expect(processor.staleIssues).toHaveLength(0);
|
|
||||||
expect(processor.closedIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import {generateIssue} from './functions/generate-issue';
|
|||||||
let issuesProcessorBuilder: IssuesProcessorBuilder;
|
let issuesProcessorBuilder: IssuesProcessorBuilder;
|
||||||
let issuesProcessor: IssuesProcessorMock;
|
let issuesProcessor: IssuesProcessorMock;
|
||||||
|
|
||||||
describe('only-labels options', (): void => {
|
describe('only-labels option', (): void => {
|
||||||
beforeEach((): void => {
|
beforeEach((): void => {
|
||||||
issuesProcessorBuilder = new IssuesProcessorBuilder();
|
issuesProcessorBuilder = new IssuesProcessorBuilder();
|
||||||
});
|
});
|
||||||
@@ -1103,7 +1103,7 @@ class IssuesProcessorBuilder {
|
|||||||
issue.updated_at ?? new Date().toDateString(),
|
issue.updated_at ?? new Date().toDateString(),
|
||||||
issue.created_at ?? new Date().toDateString(),
|
issue.created_at ?? new Date().toDateString(),
|
||||||
!!issue.pull_request,
|
!!issue.pull_request,
|
||||||
issue.labels ? issue.labels.map(label => label.name || '') : []
|
issue.labels ? issue.labels.map(label => label.name) : []
|
||||||
)
|
)
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import {IssuesProcessorMock} from './classes/issues-processor-mock';
|
|||||||
import {DefaultProcessorOptions} from './constants/default-processor-options';
|
import {DefaultProcessorOptions} from './constants/default-processor-options';
|
||||||
import {generateIssue} from './functions/generate-issue';
|
import {generateIssue} from './functions/generate-issue';
|
||||||
|
|
||||||
describe('operations-per-run option', (): void => {
|
describe('operations per run option', (): void => {
|
||||||
let sut: SUT;
|
let sut: SUT;
|
||||||
|
|
||||||
beforeEach((): void => {
|
beforeEach((): void => {
|
||||||
|
|||||||
@@ -455,7 +455,7 @@ class IssuesProcessorBuilder {
|
|||||||
issue.updated_at ?? new Date().toDateString(),
|
issue.updated_at ?? new Date().toDateString(),
|
||||||
issue.created_at ?? new Date().toDateString(),
|
issue.created_at ?? new Date().toDateString(),
|
||||||
!!issue.pull_request,
|
!!issue.pull_request,
|
||||||
issue.labels ? issue.labels.map(label => label.name || '') : []
|
issue.labels ? issue.labels.map(label => label.name) : []
|
||||||
)
|
)
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|||||||
@@ -1,696 +0,0 @@
|
|||||||
import {Issue} from '../src/classes/issue';
|
|
||||||
import {IIssuesProcessorOptions} from '../src/interfaces/issues-processor-options';
|
|
||||||
import {IsoDateString} from '../src/types/iso-date-string';
|
|
||||||
import {IssuesProcessorMock} from './classes/issues-processor-mock';
|
|
||||||
import {DefaultProcessorOptions} from './constants/default-processor-options';
|
|
||||||
import {generateIssue} from './functions/generate-issue';
|
|
||||||
|
|
||||||
describe('ignore-updates options', (): void => {
|
|
||||||
let sut: SUT;
|
|
||||||
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut = new SUT();
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the issue should be stale within 10 days and was created 20 days ago and updated 5 days ago', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.toIssue().staleIn(10).created(20).updated(5);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should not stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignoreIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should not stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is unset', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.unsetIgnoreIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should not stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignoreUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignoreIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should not stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is unset', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.unsetIgnoreIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the issue should be stale within 10 days and was created 20 days ago and updated 15 days ago', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.toIssue().staleIn(10).created(20).updated(15);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignoreIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is unset', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.unsetIgnoreIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignoreUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignoreIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore issue updates option is unset', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.unsetIgnoreIssueUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the issue', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the pull request should be stale within 10 days and was created 20 days ago and updated 5 days ago', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.toPullRequest().staleIn(10).created(20).updated(5);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should not stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignorePullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnPullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should not stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is unset', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.unsetIgnorePullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should not stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignoreUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignorePullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnPullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should not stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is unset', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.unsetIgnorePullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the pull request should be stale within 10 days and was created 20 days ago and updated 15 days ago', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.toPullRequest().staleIn(10).created(20).updated(15);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignorePullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnPullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is unset', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.unsetIgnorePullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignoreUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is enabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.ignorePullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is disabled', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.staleOnPullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the ignore pull request updates option is unset', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
sut.unsetIgnorePullRequestUpdates();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should stale the pull request', async () => {
|
|
||||||
expect.assertions(3);
|
|
||||||
|
|
||||||
await sut.test();
|
|
||||||
|
|
||||||
expect(sut.processor.staleIssues).toHaveLength(1);
|
|
||||||
expect(sut.processor.closedIssues).toHaveLength(0);
|
|
||||||
expect(sut.processor.removedLabelIssues).toHaveLength(0);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
class SUT {
|
|
||||||
processor!: IssuesProcessorMock;
|
|
||||||
private _opts: IIssuesProcessorOptions = {...DefaultProcessorOptions};
|
|
||||||
private _isPullRequest = false;
|
|
||||||
private _createdAt: IsoDateString = '2020-01-01T17:00:00Z';
|
|
||||||
private _updatedAt: IsoDateString = '2020-01-01T17:00:00Z';
|
|
||||||
private _testIssueList: Issue[] = [];
|
|
||||||
|
|
||||||
toIssue(): SUT {
|
|
||||||
this._isPullRequest = false;
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
toPullRequest(): SUT {
|
|
||||||
this._isPullRequest = true;
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
staleIn(days: number): SUT {
|
|
||||||
this._updateOptions({
|
|
||||||
daysBeforeIssueStale: days,
|
|
||||||
daysBeforePrStale: days
|
|
||||||
});
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
created(daysAgo: number): SUT {
|
|
||||||
const today = new Date();
|
|
||||||
today.setDate(today.getDate() - daysAgo);
|
|
||||||
this._createdAt = today.toISOString();
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
updated(daysAgo: number): SUT {
|
|
||||||
const today = new Date();
|
|
||||||
today.setDate(today.getDate() - daysAgo);
|
|
||||||
this._updatedAt = today.toISOString();
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
ignoreUpdates(): SUT {
|
|
||||||
this._updateOptions({
|
|
||||||
ignoreUpdates: true
|
|
||||||
});
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
staleOnUpdates(): SUT {
|
|
||||||
this._updateOptions({
|
|
||||||
ignoreUpdates: false
|
|
||||||
});
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
ignoreIssueUpdates(): SUT {
|
|
||||||
this._updateOptions({
|
|
||||||
ignoreIssueUpdates: true
|
|
||||||
});
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
staleOnIssueUpdates(): SUT {
|
|
||||||
this._updateOptions({
|
|
||||||
ignoreIssueUpdates: false
|
|
||||||
});
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
unsetIgnoreIssueUpdates(): SUT {
|
|
||||||
this._updateOptions({
|
|
||||||
ignoreIssueUpdates: undefined
|
|
||||||
});
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
ignorePullRequestUpdates(): SUT {
|
|
||||||
this._updateOptions({
|
|
||||||
ignorePrUpdates: true
|
|
||||||
});
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
staleOnPullRequestUpdates(): SUT {
|
|
||||||
this._updateOptions({
|
|
||||||
ignorePrUpdates: false
|
|
||||||
});
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
unsetIgnorePullRequestUpdates(): SUT {
|
|
||||||
this._updateOptions({
|
|
||||||
ignorePrUpdates: undefined
|
|
||||||
});
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
async test(): Promise<number> {
|
|
||||||
return this._setTestIssueList()._setProcessor();
|
|
||||||
}
|
|
||||||
|
|
||||||
private _updateOptions(opts: Partial<IIssuesProcessorOptions>): SUT {
|
|
||||||
this._opts = {...this._opts, ...opts};
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
private _setTestIssueList(): SUT {
|
|
||||||
this._testIssueList = [
|
|
||||||
generateIssue(
|
|
||||||
this._opts,
|
|
||||||
1,
|
|
||||||
'My first issue',
|
|
||||||
this._updatedAt,
|
|
||||||
this._createdAt,
|
|
||||||
this._isPullRequest
|
|
||||||
)
|
|
||||||
];
|
|
||||||
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
private async _setProcessor(): Promise<number> {
|
|
||||||
this.processor = new IssuesProcessorMock(
|
|
||||||
this._opts,
|
|
||||||
async p => (p === 1 ? this._testIssueList : []),
|
|
||||||
async () => [],
|
|
||||||
async () => new Date().toDateString()
|
|
||||||
);
|
|
||||||
|
|
||||||
return this.processor.processIssues(1);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
34
action.yml
34
action.yml
@@ -49,10 +49,6 @@ inputs:
|
|||||||
description: 'The labels that mean an issue is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2").'
|
description: 'The labels that mean an issue is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2").'
|
||||||
default: ''
|
default: ''
|
||||||
required: false
|
required: false
|
||||||
close-issue-reason:
|
|
||||||
description: 'The reason to use when closing an issue.'
|
|
||||||
default: 'not_planned'
|
|
||||||
required: false
|
|
||||||
stale-pr-label:
|
stale-pr-label:
|
||||||
description: 'The label to apply when a pull request is stale.'
|
description: 'The label to apply when a pull request is stale.'
|
||||||
default: 'Stale'
|
default: 'Stale'
|
||||||
@@ -168,43 +164,15 @@ inputs:
|
|||||||
description: 'Exempt all pull requests with assignees from being marked as stale. Override "exempt-all-assignees" option regarding only the pull requests.'
|
description: 'Exempt all pull requests with assignees from being marked as stale. Override "exempt-all-assignees" option regarding only the pull requests.'
|
||||||
default: ''
|
default: ''
|
||||||
required: false
|
required: false
|
||||||
exempt-draft-pr:
|
|
||||||
description: 'Exempt draft pull requests from being marked as stale. Default to false.'
|
|
||||||
default: 'false'
|
|
||||||
required: false
|
|
||||||
enable-statistics:
|
enable-statistics:
|
||||||
description: 'Display some statistics at the end regarding the stale workflow (only when the logs are enabled).'
|
description: 'Display some statistics at the end regarding the stale workflow (only when the logs are enabled).'
|
||||||
default: 'true'
|
default: 'true'
|
||||||
required: false
|
required: false
|
||||||
labels-to-add-when-unstale:
|
|
||||||
description: 'A comma delimited list of labels to add when a stale issue or pull request receives activity and has the stale-issue-label or stale-pr-label removed from it.'
|
|
||||||
default: ''
|
|
||||||
required: false
|
|
||||||
labels-to-remove-when-unstale:
|
|
||||||
description: 'A comma delimited list of labels to remove when a stale issue or pull request receives activity and has the stale-issue-label or stale-pr-label removed from it.'
|
|
||||||
default: ''
|
|
||||||
required: false
|
|
||||||
ignore-updates:
|
|
||||||
description: 'Any update (update/comment) can reset the stale idle time on the issues and pull requests.'
|
|
||||||
default: 'false'
|
|
||||||
required: false
|
|
||||||
ignore-issue-updates:
|
|
||||||
description: 'Any update (update/comment) can reset the stale idle time on the issues. Override "ignore-updates" option regarding only the issues.'
|
|
||||||
default: ''
|
|
||||||
required: false
|
|
||||||
ignore-pr-updates:
|
|
||||||
description: 'Any update (update/comment) can reset the stale idle time on the pull requests. Override "ignore-updates" option regarding only the pull requests.'
|
|
||||||
default: ''
|
|
||||||
required: false
|
|
||||||
include-only-assigned:
|
|
||||||
description: 'Only the issues or the pull requests with an assignee will be marked as stale automatically.'
|
|
||||||
default: 'false'
|
|
||||||
required: false
|
|
||||||
outputs:
|
outputs:
|
||||||
closed-issues-prs:
|
closed-issues-prs:
|
||||||
description: 'List of all closed issues and pull requests.'
|
description: 'List of all closed issues and pull requests.'
|
||||||
staled-issues-prs:
|
staled-issues-prs:
|
||||||
description: 'List of all staled issues and pull requests.'
|
description: 'List of all staled issues and pull requests.'
|
||||||
runs:
|
runs:
|
||||||
using: 'node16'
|
using: 'node12'
|
||||||
main: 'dist/index.js'
|
main: 'dist/index.js'
|
||||||
|
|||||||
6466
dist/index.js
vendored
6466
dist/index.js
vendored
File diff suppressed because one or more lines are too long
20146
package-lock.json
generated
20146
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
29
package.json
29
package.json
@@ -6,8 +6,8 @@
|
|||||||
"main": "lib/main.js",
|
"main": "lib/main.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc --project tsconfig.app.json",
|
"build": "tsc --project tsconfig.app.json",
|
||||||
"format": "prettier --write --ignore-unknown **/*.{json,yml,ts}",
|
"format": "prettier --write --ignore-unknown **/*.{md,json,yml,ts}",
|
||||||
"format-check": "prettier --check --ignore-unknown **/*.{json,yml,ts}",
|
"format-check": "prettier --check --ignore-unknown **/*.{md,json,yml,ts}",
|
||||||
"lint": "eslint src/**/*.ts",
|
"lint": "eslint src/**/*.ts",
|
||||||
"lint:fix": "eslint src/**/*.ts --fix",
|
"lint:fix": "eslint src/**/*.ts --fix",
|
||||||
"lint:all": "npm run format-check && npm run lint",
|
"lint:all": "npm run format-check && npm run lint",
|
||||||
@@ -17,7 +17,6 @@
|
|||||||
"test:only-errors": "jest --reporters jest-silent-reporter --silent",
|
"test:only-errors": "jest --reporters jest-silent-reporter --silent",
|
||||||
"test:watch": "jest --watch --notify --expand",
|
"test:watch": "jest --watch --notify --expand",
|
||||||
"all": "npm run build && npm run format && npm run lint && npm run pack && npm test",
|
"all": "npm run build && npm run format && npm run lint && npm run pack && npm test",
|
||||||
"all:ci": "npm run build && npm run lint:all && npm run pack && npm run test:only-errors",
|
|
||||||
"prerelease": "npm run build && npm run pack",
|
"prerelease": "npm run build && npm run pack",
|
||||||
"release": "standard-version",
|
"release": "standard-version",
|
||||||
"release:dry-run": "standard-version --dry-run"
|
"release:dry-run": "standard-version --dry-run"
|
||||||
@@ -38,31 +37,31 @@
|
|||||||
"author": "GitHub",
|
"author": "GitHub",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": "^1.10.0",
|
"@actions/core": "^1.2.6",
|
||||||
"@actions/github": "^5.0.1",
|
"@actions/github": "^4.0.0",
|
||||||
"lodash.deburr": "^4.1.0",
|
"lodash.deburr": "^4.1.0",
|
||||||
"semver": "^7.3.5"
|
"semver": "^7.3.5"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/jest": "^27.0.2",
|
"@types/jest": "^26.0.23",
|
||||||
"@types/lodash.deburr": "^4.1.6",
|
"@types/lodash.deburr": "^4.1.6",
|
||||||
"@types/node": "^15.0.2",
|
"@types/node": "^15.0.2",
|
||||||
"@types/semver": "^7.3.5",
|
"@types/semver": "^7.3.5",
|
||||||
"@typescript-eslint/eslint-plugin": "^4.31.1",
|
"@typescript-eslint/eslint-plugin": "^4.26.0",
|
||||||
"@typescript-eslint/parser": "^4.31.1",
|
"@typescript-eslint/parser": "^4.26.1",
|
||||||
"@vercel/ncc": "^0.28.6",
|
"@vercel/ncc": "^0.28.6",
|
||||||
"ansi-styles": "5.2.0",
|
"ansi-styles": "5.2.0",
|
||||||
"eslint": "^7.28.0",
|
"eslint": "^7.28.0",
|
||||||
"eslint-plugin-github": "^4.1.2",
|
"eslint-plugin-github": "^4.1.2",
|
||||||
"eslint-plugin-jest": "^25.3.2",
|
"eslint-plugin-jest": "^24.3.6",
|
||||||
"jest": "^27.2.5",
|
"jest": "^26.6.3",
|
||||||
"jest-circus": "^27.4.6",
|
"jest-circus": "^26.6.3",
|
||||||
"jest-silent-reporter": "^0.5.0",
|
"jest-silent-reporter": "^0.4.0",
|
||||||
"js-yaml": "^4.1.0",
|
"js-yaml": "^4.1.0",
|
||||||
"prettier": "^2.5.1",
|
"prettier": "^2.3.1",
|
||||||
"standard-version": "^9.3.1",
|
"standard-version": "^9.2.0",
|
||||||
"terminal-link": "^2.1.1",
|
"terminal-link": "^2.1.1",
|
||||||
"ts-jest": "^27.1.2",
|
"ts-jest": "^26.5.6",
|
||||||
"typescript": "^4.3.2"
|
"typescript": "^4.3.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,7 +1,7 @@
|
|||||||
import deburr from 'lodash.deburr';
|
import deburr from 'lodash.deburr';
|
||||||
import {Option} from '../enums/option';
|
import {Option} from '../enums/option';
|
||||||
import {wordsToList} from '../functions/words-to-list';
|
import {wordsToList} from '../functions/words-to-list';
|
||||||
import {Assignee} from '../interfaces/assignee';
|
import {IAssignee} from '../interfaces/assignee';
|
||||||
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
|
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
|
||||||
import {Issue} from './issue';
|
import {Issue} from './issue';
|
||||||
import {IssueLogger} from './loggers/issue-logger';
|
import {IssueLogger} from './loggers/issue-logger';
|
||||||
@@ -10,6 +10,10 @@ import {LoggerService} from '../services/logger.service';
|
|||||||
type CleanAssignee = string;
|
type CleanAssignee = string;
|
||||||
|
|
||||||
export class Assignees {
|
export class Assignees {
|
||||||
|
private static _cleanAssignee(assignee: Readonly<string>): CleanAssignee {
|
||||||
|
return deburr(assignee.toLowerCase());
|
||||||
|
}
|
||||||
|
|
||||||
private readonly _options: IIssuesProcessorOptions;
|
private readonly _options: IIssuesProcessorOptions;
|
||||||
private readonly _issue: Issue;
|
private readonly _issue: Issue;
|
||||||
private readonly _issueLogger: IssueLogger;
|
private readonly _issueLogger: IssueLogger;
|
||||||
@@ -20,10 +24,6 @@ export class Assignees {
|
|||||||
this._issueLogger = new IssueLogger(issue);
|
this._issueLogger = new IssueLogger(issue);
|
||||||
}
|
}
|
||||||
|
|
||||||
private static _cleanAssignee(assignee: Readonly<string>): CleanAssignee {
|
|
||||||
return deburr(assignee.toLowerCase());
|
|
||||||
}
|
|
||||||
|
|
||||||
shouldExemptAssignees(): boolean {
|
shouldExemptAssignees(): boolean {
|
||||||
if (!this._issue.hasAssignees) {
|
if (!this._issue.hasAssignees) {
|
||||||
this._issueLogger.info('This $$type has no assignee');
|
this._issueLogger.info('This $$type has no assignee');
|
||||||
@@ -195,7 +195,7 @@ export class Assignees {
|
|||||||
const cleanAssignee: CleanAssignee = Assignees._cleanAssignee(assignee);
|
const cleanAssignee: CleanAssignee = Assignees._cleanAssignee(assignee);
|
||||||
|
|
||||||
return this._issue.assignees.some(
|
return this._issue.assignees.some(
|
||||||
(issueAssignee: Readonly<Assignee>): boolean => {
|
(issueAssignee: Readonly<IAssignee>): boolean => {
|
||||||
const isSameAssignee: boolean =
|
const isSameAssignee: boolean =
|
||||||
cleanAssignee === Assignees._cleanAssignee(issueAssignee.login);
|
cleanAssignee === Assignees._cleanAssignee(issueAssignee.login);
|
||||||
|
|
||||||
|
|||||||
@@ -1,51 +0,0 @@
|
|||||||
import {Option} from '../enums/option';
|
|
||||||
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
|
|
||||||
import {IPullRequest} from '../interfaces/pull-request';
|
|
||||||
import {LoggerService} from '../services/logger.service';
|
|
||||||
import {Issue} from './issue';
|
|
||||||
import {IssueLogger} from './loggers/issue-logger';
|
|
||||||
|
|
||||||
export class ExemptDraftPullRequest {
|
|
||||||
private readonly _options: IIssuesProcessorOptions;
|
|
||||||
private readonly _issue: Issue;
|
|
||||||
private readonly _issueLogger: IssueLogger;
|
|
||||||
|
|
||||||
constructor(options: Readonly<IIssuesProcessorOptions>, issue: Issue) {
|
|
||||||
this._options = options;
|
|
||||||
this._issue = issue;
|
|
||||||
this._issueLogger = new IssueLogger(issue);
|
|
||||||
}
|
|
||||||
|
|
||||||
async shouldExemptDraftPullRequest(
|
|
||||||
pullRequestCallback: () => Promise<IPullRequest | undefined | void>
|
|
||||||
): Promise<boolean> {
|
|
||||||
if (this._issue.isPullRequest) {
|
|
||||||
if (this._options.exemptDraftPr) {
|
|
||||||
this._issueLogger.info(
|
|
||||||
`The option ${this._issueLogger.createOptionLink(
|
|
||||||
Option.ExemptDraftPr
|
|
||||||
)} is enabled`
|
|
||||||
);
|
|
||||||
|
|
||||||
const pullRequest: IPullRequest | undefined | void =
|
|
||||||
await pullRequestCallback();
|
|
||||||
|
|
||||||
if (pullRequest?.draft === true) {
|
|
||||||
this._issueLogger.info(
|
|
||||||
LoggerService.white('└──'),
|
|
||||||
`Skip the $$type draft checks`
|
|
||||||
);
|
|
||||||
|
|
||||||
return true;
|
|
||||||
} else {
|
|
||||||
this._issueLogger.info(
|
|
||||||
LoggerService.white('└──'),
|
|
||||||
`Continuing the process for this $$type because it is not a draft`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,251 +0,0 @@
|
|||||||
import {DefaultProcessorOptions} from '../../__tests__/constants/default-processor-options';
|
|
||||||
import {generateIIssue} from '../../__tests__/functions/generate-iissue';
|
|
||||||
import {IIssue} from '../interfaces/issue';
|
|
||||||
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
|
|
||||||
import {IgnoreUpdates} from './ignore-updates';
|
|
||||||
import {Issue} from './issue';
|
|
||||||
|
|
||||||
describe('IgnoreUpdates', (): void => {
|
|
||||||
let ignoreUpdates: IgnoreUpdates;
|
|
||||||
let optionsInterface: IIssuesProcessorOptions;
|
|
||||||
let issue: Issue;
|
|
||||||
let issueInterface: IIssue;
|
|
||||||
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface = {
|
|
||||||
...DefaultProcessorOptions,
|
|
||||||
ignoreIssueUpdates: true
|
|
||||||
};
|
|
||||||
issueInterface = generateIIssue();
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('shouldIgnoreUpdates()', (): void => {
|
|
||||||
describe('when the given issue is not a pull request', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
issueInterface.pull_request = undefined;
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to reset the stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignoreUpdates = false;
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are not configured to reset the issue stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
delete optionsInterface.ignoreIssueUpdates;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return false', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to reset the issue stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignoreIssueUpdates = false;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return false', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to not reset the issue stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignoreIssueUpdates = true;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return true', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to reset the stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignoreUpdates = true;
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are not configured to reset the issue stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
delete optionsInterface.ignoreIssueUpdates;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return true', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to reset the issue stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignoreIssueUpdates = false;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return false', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to not reset the issue stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignoreIssueUpdates = true;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return true', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given issue is a pull request', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
issueInterface.pull_request = {};
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to reset the stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignoreUpdates = false;
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are not configured to reset the pull request stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
delete optionsInterface.ignorePrUpdates;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return false', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to reset the pull request stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignorePrUpdates = false;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return false', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to not reset the pull request stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignorePrUpdates = true;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return true', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to not reset the stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignoreUpdates = true;
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are not configured to reset the pull request stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
delete optionsInterface.ignorePrUpdates;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return true', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to reset the pull request stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignorePrUpdates = false;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return false', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when the given options are configured to not reset the pull request stale on updates', (): void => {
|
|
||||||
beforeEach((): void => {
|
|
||||||
optionsInterface.ignorePrUpdates = true;
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should return true', (): void => {
|
|
||||||
expect.assertions(1);
|
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
|
||||||
ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
|
|
||||||
|
|
||||||
const result = ignoreUpdates.shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
expect(result).toStrictEqual(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,90 +0,0 @@
|
|||||||
import {Option} from '../enums/option';
|
|
||||||
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
|
|
||||||
import {Issue} from './issue';
|
|
||||||
import {IssueLogger} from './loggers/issue-logger';
|
|
||||||
|
|
||||||
export class IgnoreUpdates {
|
|
||||||
private readonly _options: IIssuesProcessorOptions;
|
|
||||||
private readonly _issue: Issue;
|
|
||||||
private readonly _issueLogger: IssueLogger;
|
|
||||||
|
|
||||||
constructor(options: Readonly<IIssuesProcessorOptions>, issue: Issue) {
|
|
||||||
this._options = options;
|
|
||||||
this._issue = issue;
|
|
||||||
this._issueLogger = new IssueLogger(issue);
|
|
||||||
}
|
|
||||||
|
|
||||||
shouldIgnoreUpdates(): boolean {
|
|
||||||
return this._shouldIgnoreUpdates();
|
|
||||||
}
|
|
||||||
|
|
||||||
private _shouldIgnoreUpdates(): boolean {
|
|
||||||
return this._issue.isPullRequest
|
|
||||||
? this._shouldIgnorePullRequestUpdates()
|
|
||||||
: this._shouldIgnoreIssueUpdates();
|
|
||||||
}
|
|
||||||
|
|
||||||
private _shouldIgnorePullRequestUpdates(): boolean {
|
|
||||||
if (this._options.ignorePrUpdates === true) {
|
|
||||||
this._issueLogger.info(
|
|
||||||
`The option ${this._issueLogger.createOptionLink(
|
|
||||||
Option.IgnorePrUpdates
|
|
||||||
)} is enabled. The stale counter will ignore any updates or comments on this $$type and will use the creation date as a reference ignoring any kind of update`
|
|
||||||
);
|
|
||||||
|
|
||||||
return true;
|
|
||||||
} else if (this._options.ignorePrUpdates === false) {
|
|
||||||
this._issueLogger.info(
|
|
||||||
`The option ${this._issueLogger.createOptionLink(
|
|
||||||
Option.IgnorePrUpdates
|
|
||||||
)} is disabled. The stale counter will take into account updates and comments on this $$type to avoid to stale when there is some update`
|
|
||||||
);
|
|
||||||
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
this._logIgnoreUpdates();
|
|
||||||
|
|
||||||
return this._options.ignoreUpdates;
|
|
||||||
}
|
|
||||||
|
|
||||||
private _shouldIgnoreIssueUpdates(): boolean {
|
|
||||||
if (this._options.ignoreIssueUpdates === true) {
|
|
||||||
this._issueLogger.info(
|
|
||||||
`The option ${this._issueLogger.createOptionLink(
|
|
||||||
Option.IgnoreIssueUpdates
|
|
||||||
)} is enabled. The stale counter will ignore any updates or comments on this $$type and will use the creation date as a reference ignoring any kind of update`
|
|
||||||
);
|
|
||||||
|
|
||||||
return true;
|
|
||||||
} else if (this._options.ignoreIssueUpdates === false) {
|
|
||||||
this._issueLogger.info(
|
|
||||||
`The option ${this._issueLogger.createOptionLink(
|
|
||||||
Option.IgnoreIssueUpdates
|
|
||||||
)} is disabled. The stale counter will take into account updates and comments on this $$type to avoid to stale when there is some update`
|
|
||||||
);
|
|
||||||
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
this._logIgnoreUpdates();
|
|
||||||
|
|
||||||
return this._options.ignoreUpdates;
|
|
||||||
}
|
|
||||||
|
|
||||||
private _logIgnoreUpdates(): void {
|
|
||||||
if (this._options.ignoreUpdates) {
|
|
||||||
this._issueLogger.info(
|
|
||||||
`The option ${this._issueLogger.createOptionLink(
|
|
||||||
Option.IgnoreUpdates
|
|
||||||
)} is enabled. The stale counter will ignore any updates or comments on this $$type and will use the creation date as a reference ignoring any kind of update`
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
this._issueLogger.info(
|
|
||||||
`The option ${this._issueLogger.createOptionLink(
|
|
||||||
Option.IgnoreUpdates
|
|
||||||
)} is disabled. The stale counter will take into account updates and comments on this $$type to avoid to stale when there is some update`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import {IUserAssignee} from '../interfaces/assignee';
|
import {IAssignee} from '../interfaces/assignee';
|
||||||
import {IIssue} from '../interfaces/issue';
|
import {IIssue} from '../interfaces/issue';
|
||||||
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
|
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
|
||||||
import {ILabel} from '../interfaces/label';
|
import {ILabel} from '../interfaces/label';
|
||||||
@@ -57,13 +57,7 @@ describe('Issue', (): void => {
|
|||||||
exemptAllPrAssignees: undefined,
|
exemptAllPrAssignees: undefined,
|
||||||
enableStatistics: false,
|
enableStatistics: false,
|
||||||
labelsToRemoveWhenUnstale: '',
|
labelsToRemoveWhenUnstale: '',
|
||||||
labelsToAddWhenUnstale: '',
|
labelsToAddWhenUnstale: ''
|
||||||
ignoreUpdates: false,
|
|
||||||
ignoreIssueUpdates: undefined,
|
|
||||||
ignorePrUpdates: undefined,
|
|
||||||
exemptDraftPr: false,
|
|
||||||
closeIssueReason: '',
|
|
||||||
includeOnlyAssigned: false
|
|
||||||
};
|
};
|
||||||
issueInterface = {
|
issueInterface = {
|
||||||
title: 'dummy-title',
|
title: 'dummy-title',
|
||||||
@@ -83,8 +77,7 @@ describe('Issue', (): void => {
|
|||||||
},
|
},
|
||||||
assignees: [
|
assignees: [
|
||||||
{
|
{
|
||||||
login: 'dummy-login',
|
login: 'dummy-login'
|
||||||
type: 'User'
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
};
|
};
|
||||||
@@ -157,9 +150,8 @@ describe('Issue', (): void => {
|
|||||||
|
|
||||||
expect(issue.assignees).toStrictEqual([
|
expect(issue.assignees).toStrictEqual([
|
||||||
{
|
{
|
||||||
login: 'dummy-login',
|
login: 'dummy-login'
|
||||||
type: 'User'
|
} as IAssignee
|
||||||
} as IUserAssignee
|
|
||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -280,8 +272,7 @@ describe('Issue', (): void => {
|
|||||||
beforeEach((): void => {
|
beforeEach((): void => {
|
||||||
issueInterface.assignees = [
|
issueInterface.assignees = [
|
||||||
{
|
{
|
||||||
login: 'dummy-login',
|
login: 'dummy-login'
|
||||||
type: 'User'
|
|
||||||
}
|
}
|
||||||
];
|
];
|
||||||
issue = new Issue(optionsInterface, issueInterface);
|
issue = new Issue(optionsInterface, issueInterface);
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import {isLabeled} from '../functions/is-labeled';
|
import {isLabeled} from '../functions/is-labeled';
|
||||||
import {isPullRequest} from '../functions/is-pull-request';
|
import {isPullRequest} from '../functions/is-pull-request';
|
||||||
import {Assignee} from '../interfaces/assignee';
|
import {IAssignee} from '../interfaces/assignee';
|
||||||
import {IIssue, OctokitIssue} from '../interfaces/issue';
|
import {IIssue} from '../interfaces/issue';
|
||||||
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
|
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
|
||||||
import {ILabel} from '../interfaces/label';
|
import {ILabel} from '../interfaces/label';
|
||||||
import {IMilestone} from '../interfaces/milestone';
|
import {IMilestone} from '../interfaces/milestone';
|
||||||
@@ -9,6 +9,7 @@ import {IsoDateString} from '../types/iso-date-string';
|
|||||||
import {Operations} from './operations';
|
import {Operations} from './operations';
|
||||||
|
|
||||||
export class Issue implements IIssue {
|
export class Issue implements IIssue {
|
||||||
|
private readonly _options: IIssuesProcessorOptions;
|
||||||
readonly title: string;
|
readonly title: string;
|
||||||
readonly number: number;
|
readonly number: number;
|
||||||
created_at: IsoDateString;
|
created_at: IsoDateString;
|
||||||
@@ -17,31 +18,10 @@ export class Issue implements IIssue {
|
|||||||
readonly pull_request: Object | null | undefined;
|
readonly pull_request: Object | null | undefined;
|
||||||
readonly state: string | 'closed' | 'open';
|
readonly state: string | 'closed' | 'open';
|
||||||
readonly locked: boolean;
|
readonly locked: boolean;
|
||||||
readonly milestone?: IMilestone | null;
|
readonly milestone: IMilestone | undefined;
|
||||||
readonly assignees: Assignee[];
|
readonly assignees: IAssignee[];
|
||||||
isStale: boolean;
|
isStale: boolean;
|
||||||
markedStaleThisRun: boolean;
|
|
||||||
operations = new Operations();
|
operations = new Operations();
|
||||||
private readonly _options: IIssuesProcessorOptions;
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
options: Readonly<IIssuesProcessorOptions>,
|
|
||||||
issue: Readonly<OctokitIssue> | Readonly<IIssue>
|
|
||||||
) {
|
|
||||||
this._options = options;
|
|
||||||
this.title = issue.title;
|
|
||||||
this.number = issue.number;
|
|
||||||
this.created_at = issue.created_at;
|
|
||||||
this.updated_at = issue.updated_at;
|
|
||||||
this.labels = mapLabels(issue.labels);
|
|
||||||
this.pull_request = issue.pull_request;
|
|
||||||
this.state = issue.state;
|
|
||||||
this.locked = issue.locked;
|
|
||||||
this.milestone = issue.milestone;
|
|
||||||
this.assignees = issue.assignees || [];
|
|
||||||
this.isStale = isLabeled(this, this.staleLabel);
|
|
||||||
this.markedStaleThisRun = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
get isPullRequest(): boolean {
|
get isPullRequest(): boolean {
|
||||||
return isPullRequest(this);
|
return isPullRequest(this);
|
||||||
@@ -55,20 +35,28 @@ export class Issue implements IIssue {
|
|||||||
return this.assignees.length > 0;
|
return this.assignees.length > 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
options: Readonly<IIssuesProcessorOptions>,
|
||||||
|
issue: Readonly<IIssue>
|
||||||
|
) {
|
||||||
|
this._options = options;
|
||||||
|
this.title = issue.title;
|
||||||
|
this.number = issue.number;
|
||||||
|
this.created_at = issue.created_at;
|
||||||
|
this.updated_at = issue.updated_at;
|
||||||
|
this.labels = issue.labels;
|
||||||
|
this.pull_request = issue.pull_request;
|
||||||
|
this.state = issue.state;
|
||||||
|
this.locked = issue.locked;
|
||||||
|
this.milestone = issue.milestone;
|
||||||
|
this.assignees = issue.assignees;
|
||||||
|
|
||||||
|
this.isStale = isLabeled(this, this.staleLabel);
|
||||||
|
}
|
||||||
|
|
||||||
private _getStaleLabel(): string {
|
private _getStaleLabel(): string {
|
||||||
return this.isPullRequest
|
return this.isPullRequest
|
||||||
? this._options.stalePrLabel
|
? this._options.stalePrLabel
|
||||||
: this._options.staleIssueLabel;
|
: this._options.staleIssueLabel;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function mapLabels(labels: (string | ILabel)[] | ILabel[]): ILabel[] {
|
|
||||||
return labels.map(label => {
|
|
||||||
if (typeof label == 'string') {
|
|
||||||
return {
|
|
||||||
name: label
|
|
||||||
};
|
|
||||||
}
|
|
||||||
return label;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,22 +1,22 @@
|
|||||||
import * as core from '@actions/core';
|
import * as core from '@actions/core';
|
||||||
import {context, getOctokit} from '@actions/github';
|
import {context, getOctokit} from '@actions/github';
|
||||||
import {GitHub} from '@actions/github/lib/utils';
|
import {GitHub} from '@actions/github/lib/utils';
|
||||||
|
import {GetResponseTypeFromEndpointMethod} from '@octokit/types';
|
||||||
import {Option} from '../enums/option';
|
import {Option} from '../enums/option';
|
||||||
import {getHumanizedDate} from '../functions/dates/get-humanized-date';
|
import {getHumanizedDate} from '../functions/dates/get-humanized-date';
|
||||||
import {isDateMoreRecentThan} from '../functions/dates/is-date-more-recent-than';
|
import {isDateMoreRecentThan} from '../functions/dates/is-date-more-recent-than';
|
||||||
import {isValidDate} from '../functions/dates/is-valid-date';
|
import {isValidDate} from '../functions/dates/is-valid-date';
|
||||||
import {isBoolean} from '../functions/is-boolean';
|
import {isBoolean} from '../functions/is-boolean';
|
||||||
import {isLabeled} from '../functions/is-labeled';
|
import {isLabeled} from '../functions/is-labeled';
|
||||||
import {cleanLabel} from '../functions/clean-label';
|
import { cleanLabel } from '../functions/clean-label';
|
||||||
import {shouldMarkWhenStale} from '../functions/should-mark-when-stale';
|
import {shouldMarkWhenStale} from '../functions/should-mark-when-stale';
|
||||||
import {wordsToList} from '../functions/words-to-list';
|
import {wordsToList} from '../functions/words-to-list';
|
||||||
import {IComment} from '../interfaces/comment';
|
import {IComment} from '../interfaces/comment';
|
||||||
|
import {IIssue} from '../interfaces/issue';
|
||||||
import {IIssueEvent} from '../interfaces/issue-event';
|
import {IIssueEvent} from '../interfaces/issue-event';
|
||||||
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
|
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
|
||||||
import {IPullRequest} from '../interfaces/pull-request';
|
import {IPullRequest} from '../interfaces/pull-request';
|
||||||
import {Assignees} from './assignees';
|
import {Assignees} from './assignees';
|
||||||
import {IgnoreUpdates} from './ignore-updates';
|
|
||||||
import {ExemptDraftPullRequest} from './exempt-draft-pull-request';
|
|
||||||
import {Issue} from './issue';
|
import {Issue} from './issue';
|
||||||
import {IssueLogger} from './loggers/issue-logger';
|
import {IssueLogger} from './loggers/issue-logger';
|
||||||
import {Logger} from './loggers/logger';
|
import {Logger} from './loggers/logger';
|
||||||
@@ -24,14 +24,13 @@ import {Milestones} from './milestones';
|
|||||||
import {StaleOperations} from './stale-operations';
|
import {StaleOperations} from './stale-operations';
|
||||||
import {Statistics} from './statistics';
|
import {Statistics} from './statistics';
|
||||||
import {LoggerService} from '../services/logger.service';
|
import {LoggerService} from '../services/logger.service';
|
||||||
import {OctokitIssue} from '../interfaces/issue';
|
|
||||||
|
|
||||||
/***
|
/***
|
||||||
* Handle processing of issues for staleness/closure.
|
* Handle processing of issues for staleness/closure.
|
||||||
*/
|
*/
|
||||||
export class IssuesProcessor {
|
export class IssuesProcessor {
|
||||||
private static _updatedSince(timestamp: string, num_days: number): boolean {
|
private static _updatedSince(timestamp: string, num_minutes: number): boolean {
|
||||||
const daysInMillis = 1000 * 60 * 60 * 24 * num_days;
|
const daysInMillis = 1000 * 60 * num_minutes;
|
||||||
const millisSinceLastUpdated =
|
const millisSinceLastUpdated =
|
||||||
new Date().getTime() - new Date(timestamp).getTime();
|
new Date().getTime() - new Date(timestamp).getTime();
|
||||||
|
|
||||||
@@ -54,12 +53,22 @@ export class IssuesProcessor {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private static _getStaleMessageUsedOptionName(
|
||||||
|
issue: Readonly<Issue>
|
||||||
|
): Option.StalePrMessage | Option.StaleIssueMessage {
|
||||||
|
return issue.isPullRequest
|
||||||
|
? Option.StalePrMessage
|
||||||
|
: Option.StaleIssueMessage;
|
||||||
|
}
|
||||||
|
|
||||||
private static _getCloseLabelUsedOptionName(
|
private static _getCloseLabelUsedOptionName(
|
||||||
issue: Readonly<Issue>
|
issue: Readonly<Issue>
|
||||||
): Option.ClosePrLabel | Option.CloseIssueLabel {
|
): Option.ClosePrLabel | Option.CloseIssueLabel {
|
||||||
return issue.isPullRequest ? Option.ClosePrLabel : Option.CloseIssueLabel;
|
return issue.isPullRequest ? Option.ClosePrLabel : Option.CloseIssueLabel;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private readonly _logger: Logger = new Logger();
|
||||||
|
private readonly _statistics: Statistics | undefined;
|
||||||
readonly operations: StaleOperations;
|
readonly operations: StaleOperations;
|
||||||
readonly client: InstanceType<typeof GitHub>;
|
readonly client: InstanceType<typeof GitHub>;
|
||||||
readonly options: IIssuesProcessorOptions;
|
readonly options: IIssuesProcessorOptions;
|
||||||
@@ -68,9 +77,6 @@ export class IssuesProcessor {
|
|||||||
readonly deletedBranchIssues: Issue[] = [];
|
readonly deletedBranchIssues: Issue[] = [];
|
||||||
readonly removedLabelIssues: Issue[] = [];
|
readonly removedLabelIssues: Issue[] = [];
|
||||||
readonly addedLabelIssues: Issue[] = [];
|
readonly addedLabelIssues: Issue[] = [];
|
||||||
readonly addedCloseCommentIssues: Issue[] = [];
|
|
||||||
readonly statistics: Statistics | undefined;
|
|
||||||
private readonly _logger: Logger = new Logger();
|
|
||||||
|
|
||||||
constructor(options: IIssuesProcessorOptions) {
|
constructor(options: IIssuesProcessorOptions) {
|
||||||
this.options = options;
|
this.options = options;
|
||||||
@@ -93,7 +99,7 @@ export class IssuesProcessor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (this.options.enableStatistics) {
|
if (this.options.enableStatistics) {
|
||||||
this.statistics = new Statistics();
|
this._statistics = new Statistics();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -105,7 +111,7 @@ export class IssuesProcessor {
|
|||||||
this._logger.info(
|
this._logger.info(
|
||||||
LoggerService.green(`No more issues found to process. Exiting...`)
|
LoggerService.green(`No more issues found to process. Exiting...`)
|
||||||
);
|
);
|
||||||
this.statistics
|
this._statistics
|
||||||
?.setOperationsCount(this.operations.getConsumedOperationsCount())
|
?.setOperationsCount(this.operations.getConsumedOperationsCount())
|
||||||
.logStats();
|
.logStats();
|
||||||
|
|
||||||
@@ -113,11 +119,11 @@ export class IssuesProcessor {
|
|||||||
} else {
|
} else {
|
||||||
this._logger.info(
|
this._logger.info(
|
||||||
`${LoggerService.yellow(
|
`${LoggerService.yellow(
|
||||||
'Processing the batch of issues '
|
'Processing the batch of issues'
|
||||||
)} ${LoggerService.cyan(`#${page}`)} ${LoggerService.yellow(
|
)} ${LoggerService.cyan(`#${page}`)} ${LoggerService.yellow(
|
||||||
' containing '
|
'containing'
|
||||||
)} ${LoggerService.cyan(issues.length)} ${LoggerService.yellow(
|
)} ${LoggerService.cyan(issues.length)} ${LoggerService.yellow(
|
||||||
` issue${issues.length > 1 ? 's' : ''}...`
|
`issue${issues.length > 1 ? 's' : ''}...`
|
||||||
)}`
|
)}`
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -151,14 +157,14 @@ export class IssuesProcessor {
|
|||||||
);
|
);
|
||||||
this._logger.warning(
|
this._logger.warning(
|
||||||
`${LoggerService.yellowBright(
|
`${LoggerService.yellowBright(
|
||||||
'If you think that not enough issues were processed you could try to increase the quantity related to the '
|
'If you think that not enough issues were processed you could try to increase the quantity related to the'
|
||||||
)} ${this._logger.createOptionLink(
|
)} ${this._logger.createOptionLink(
|
||||||
Option.OperationsPerRun
|
Option.OperationsPerRun
|
||||||
)} ${LoggerService.yellowBright(
|
)} ${LoggerService.yellowBright(
|
||||||
' option which is currently set to '
|
'option which is currently set to'
|
||||||
)} ${LoggerService.cyan(this.options.operationsPerRun)}`
|
)} ${LoggerService.cyan(this.options.operationsPerRun)}`
|
||||||
);
|
);
|
||||||
this.statistics
|
this._statistics
|
||||||
?.setOperationsCount(this.operations.getConsumedOperationsCount())
|
?.setOperationsCount(this.operations.getConsumedOperationsCount())
|
||||||
.logStats();
|
.logStats();
|
||||||
|
|
||||||
@@ -166,9 +172,9 @@ export class IssuesProcessor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
this._logger.info(
|
this._logger.info(
|
||||||
`${LoggerService.green('Batch ')} ${LoggerService.cyan(
|
`${LoggerService.green('Batch')} ${LoggerService.cyan(
|
||||||
`#${page}`
|
`#${page}`
|
||||||
)} ${LoggerService.green(' processed.')}`
|
)} ${LoggerService.green('processed.')}`
|
||||||
);
|
);
|
||||||
|
|
||||||
// Do the next batch
|
// Do the next batch
|
||||||
@@ -180,7 +186,7 @@ export class IssuesProcessor {
|
|||||||
labelsToAddWhenUnstale: Readonly<string>[],
|
labelsToAddWhenUnstale: Readonly<string>[],
|
||||||
labelsToRemoveWhenUnstale: Readonly<string>[]
|
labelsToRemoveWhenUnstale: Readonly<string>[]
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
this.statistics?.incrementProcessedItemsCount(issue);
|
this._statistics?.incrementProcessedItemsCount(issue);
|
||||||
|
|
||||||
const issueLogger: IssueLogger = new IssueLogger(issue);
|
const issueLogger: IssueLogger = new IssueLogger(issue);
|
||||||
issueLogger.info(
|
issueLogger.info(
|
||||||
@@ -208,27 +214,6 @@ export class IssuesProcessor {
|
|||||||
const daysBeforeStale: number = issue.isPullRequest
|
const daysBeforeStale: number = issue.isPullRequest
|
||||||
? this._getDaysBeforePrStale()
|
? this._getDaysBeforePrStale()
|
||||||
: this._getDaysBeforeIssueStale();
|
: this._getDaysBeforeIssueStale();
|
||||||
|
|
||||||
if (issue.state === 'closed') {
|
|
||||||
issueLogger.info(`Skipping this $$type because it is closed`);
|
|
||||||
IssuesProcessor._endIssueProcessing(issue);
|
|
||||||
return; // Don't process closed issues
|
|
||||||
}
|
|
||||||
|
|
||||||
if (issue.locked) {
|
|
||||||
issueLogger.info(`Skipping this $$type because it is locked`);
|
|
||||||
IssuesProcessor._endIssueProcessing(issue);
|
|
||||||
return; // Don't process locked issues
|
|
||||||
}
|
|
||||||
|
|
||||||
if (this._isIncludeOnlyAssigned(issue)) {
|
|
||||||
issueLogger.info(
|
|
||||||
`Skipping this $$type because its assignees list is empty`
|
|
||||||
);
|
|
||||||
IssuesProcessor._endIssueProcessing(issue);
|
|
||||||
return; // If the issue has an 'include-only-assigned' option set, process only issues with nonempty assignees list
|
|
||||||
}
|
|
||||||
|
|
||||||
const onlyLabels: string[] = wordsToList(this._getOnlyLabels(issue));
|
const onlyLabels: string[] = wordsToList(this._getOnlyLabels(issue));
|
||||||
|
|
||||||
if (onlyLabels.length > 0) {
|
if (onlyLabels.length > 0) {
|
||||||
@@ -282,6 +267,18 @@ export class IssuesProcessor {
|
|||||||
|
|
||||||
const shouldMarkAsStale: boolean = shouldMarkWhenStale(daysBeforeStale);
|
const shouldMarkAsStale: boolean = shouldMarkWhenStale(daysBeforeStale);
|
||||||
|
|
||||||
|
if (issue.state === 'closed') {
|
||||||
|
issueLogger.info(`Skipping this $$type because it is closed`);
|
||||||
|
IssuesProcessor._endIssueProcessing(issue);
|
||||||
|
return; // Don't process closed issues
|
||||||
|
}
|
||||||
|
|
||||||
|
if (issue.locked) {
|
||||||
|
issueLogger.info(`Skipping this $$type because it is locked`);
|
||||||
|
IssuesProcessor._endIssueProcessing(issue);
|
||||||
|
return; // Don't process locked issues
|
||||||
|
}
|
||||||
|
|
||||||
// Try to remove the close label when not close/locked issue or PR
|
// Try to remove the close label when not close/locked issue or PR
|
||||||
await this._removeCloseLabel(issue, closeLabel);
|
await this._removeCloseLabel(issue, closeLabel);
|
||||||
|
|
||||||
@@ -407,63 +404,23 @@ export class IssuesProcessor {
|
|||||||
return; // Don't process exempt assignees
|
return; // Don't process exempt assignees
|
||||||
}
|
}
|
||||||
|
|
||||||
// Ignore draft PR
|
// Should this issue be marked stale?
|
||||||
// Note that this check is so far below because it cost one read operation
|
const shouldBeStale = !IssuesProcessor._updatedSince(
|
||||||
// So it's simply better to do all the stale checks which don't cost more operation before this one
|
issue.updated_at,
|
||||||
const exemptDraftPullRequest: ExemptDraftPullRequest =
|
daysBeforeStale
|
||||||
new ExemptDraftPullRequest(this.options, issue);
|
);
|
||||||
|
|
||||||
if (
|
|
||||||
await exemptDraftPullRequest.shouldExemptDraftPullRequest(
|
|
||||||
async (): Promise<IPullRequest | undefined | void> => {
|
|
||||||
return this.getPullRequest(issue);
|
|
||||||
}
|
|
||||||
)
|
|
||||||
) {
|
|
||||||
IssuesProcessor._endIssueProcessing(issue);
|
|
||||||
return; // Don't process draft PR
|
|
||||||
}
|
|
||||||
|
|
||||||
// Determine if this issue needs to be marked stale first
|
// Determine if this issue needs to be marked stale first
|
||||||
if (!issue.isStale) {
|
if (!issue.isStale) {
|
||||||
issueLogger.info(`This $$type is not stale`);
|
issueLogger.info(`This $$type is not stale`);
|
||||||
const shouldIgnoreUpdates: boolean = new IgnoreUpdates(
|
const updatedAtDate: Date = new Date(issue.updated_at);
|
||||||
this.options,
|
|
||||||
issue
|
|
||||||
).shouldIgnoreUpdates();
|
|
||||||
|
|
||||||
// Should this issue be marked as stale?
|
|
||||||
let shouldBeStale: boolean;
|
|
||||||
|
|
||||||
// Ignore the last update and only use the creation date
|
|
||||||
if (shouldIgnoreUpdates) {
|
|
||||||
shouldBeStale = !IssuesProcessor._updatedSince(
|
|
||||||
issue.created_at,
|
|
||||||
daysBeforeStale
|
|
||||||
);
|
|
||||||
}
|
|
||||||
// Use the last update to check if we need to stale
|
|
||||||
else {
|
|
||||||
shouldBeStale = !IssuesProcessor._updatedSince(
|
|
||||||
issue.updated_at,
|
|
||||||
daysBeforeStale
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (shouldBeStale) {
|
if (shouldBeStale) {
|
||||||
if (shouldIgnoreUpdates) {
|
issueLogger.info(
|
||||||
issueLogger.info(
|
`This $$type should be stale based on the last update date the ${getHumanizedDate(
|
||||||
`This $$type should be stale based on the creation date the ${getHumanizedDate(
|
updatedAtDate
|
||||||
new Date(issue.created_at)
|
)} (${LoggerService.cyan(issue.updated_at)})`
|
||||||
)} (${LoggerService.cyan(issue.created_at)})`
|
);
|
||||||
);
|
|
||||||
} else {
|
|
||||||
issueLogger.info(
|
|
||||||
`This $$type should be stale based on the last update date the ${getHumanizedDate(
|
|
||||||
new Date(issue.updated_at)
|
|
||||||
)} (${LoggerService.cyan(issue.updated_at)})`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (shouldMarkAsStale) {
|
if (shouldMarkAsStale) {
|
||||||
issueLogger.info(
|
issueLogger.info(
|
||||||
@@ -473,7 +430,6 @@ export class IssuesProcessor {
|
|||||||
);
|
);
|
||||||
await this._markStale(issue, staleMessage, staleLabel, skipMessage);
|
await this._markStale(issue, staleMessage, staleLabel, skipMessage);
|
||||||
issue.isStale = true; // This issue is now considered stale
|
issue.isStale = true; // This issue is now considered stale
|
||||||
issue.markedStaleThisRun = true;
|
|
||||||
issueLogger.info(`This $$type is now stale`);
|
issueLogger.info(`This $$type is now stale`);
|
||||||
} else {
|
} else {
|
||||||
issueLogger.info(
|
issueLogger.info(
|
||||||
@@ -483,19 +439,11 @@ export class IssuesProcessor {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
if (shouldIgnoreUpdates) {
|
issueLogger.info(
|
||||||
issueLogger.info(
|
`This $$type should not be stale based on the last update date the ${getHumanizedDate(
|
||||||
`This $$type should not be stale based on the creation date the ${getHumanizedDate(
|
updatedAtDate
|
||||||
new Date(issue.created_at)
|
)} (${LoggerService.cyan(issue.updated_at)})`
|
||||||
)} (${LoggerService.cyan(issue.created_at)})`
|
);
|
||||||
);
|
|
||||||
} else {
|
|
||||||
issueLogger.info(
|
|
||||||
`This $$type should not be stale based on the last update date the ${getHumanizedDate(
|
|
||||||
new Date(issue.updated_at)
|
|
||||||
)} (${LoggerService.cyan(issue.updated_at)})`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -518,17 +466,17 @@ export class IssuesProcessor {
|
|||||||
|
|
||||||
// Grab comments for an issue since a given date
|
// Grab comments for an issue since a given date
|
||||||
async listIssueComments(
|
async listIssueComments(
|
||||||
issue: Readonly<Issue>,
|
issueNumber: Readonly<number>,
|
||||||
sinceDate: Readonly<string>
|
sinceDate: Readonly<string>
|
||||||
): Promise<IComment[]> {
|
): Promise<IComment[]> {
|
||||||
// Find any comments since date on the given issue
|
// Find any comments since date on the given issue
|
||||||
try {
|
try {
|
||||||
this._consumeIssueOperation(issue);
|
this.operations.consumeOperation();
|
||||||
this.statistics?.incrementFetchedItemsCommentsCount();
|
this._statistics?.incrementFetchedItemsCommentsCount();
|
||||||
const comments = await this.client.rest.issues.listComments({
|
const comments = await this.client.issues.listComments({
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
issue_number: issue.number,
|
issue_number: issueNumber,
|
||||||
since: sinceDate
|
since: sinceDate
|
||||||
});
|
});
|
||||||
return comments.data;
|
return comments.data;
|
||||||
@@ -540,20 +488,25 @@ export class IssuesProcessor {
|
|||||||
|
|
||||||
// grab issues from github in batches of 100
|
// grab issues from github in batches of 100
|
||||||
async getIssues(page: number): Promise<Issue[]> {
|
async getIssues(page: number): Promise<Issue[]> {
|
||||||
|
// generate type for response
|
||||||
|
const endpoint = this.client.issues.listForRepo;
|
||||||
|
type OctoKitIssueList = GetResponseTypeFromEndpointMethod<typeof endpoint>;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
this.operations.consumeOperation();
|
this.operations.consumeOperation();
|
||||||
const issueResult = await this.client.rest.issues.listForRepo({
|
const issueResult: OctoKitIssueList =
|
||||||
owner: context.repo.owner,
|
await this.client.issues.listForRepo({
|
||||||
repo: context.repo.repo,
|
owner: context.repo.owner,
|
||||||
state: 'open',
|
repo: context.repo.repo,
|
||||||
per_page: 100,
|
state: 'open',
|
||||||
direction: this.options.ascending ? 'asc' : 'desc',
|
per_page: 100,
|
||||||
page
|
direction: this.options.ascending ? 'asc' : 'desc',
|
||||||
});
|
page
|
||||||
this.statistics?.incrementFetchedItemsCount(issueResult.data.length);
|
});
|
||||||
|
this._statistics?.incrementFetchedItemsCount(issueResult.data.length);
|
||||||
|
|
||||||
return issueResult.data.map(
|
return issueResult.data.map(
|
||||||
(issue: Readonly<OctokitIssue>): Issue => new Issue(this.options, issue)
|
(issue: Readonly<IIssue>): Issue => new Issue(this.options, issue)
|
||||||
);
|
);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
this._logger.error(`Get issues for repo error: ${error.message}`);
|
this._logger.error(`Get issues for repo error: ${error.message}`);
|
||||||
@@ -572,8 +525,8 @@ export class IssuesProcessor {
|
|||||||
issueLogger.info(`Checking for label on this $$type`);
|
issueLogger.info(`Checking for label on this $$type`);
|
||||||
|
|
||||||
this._consumeIssueOperation(issue);
|
this._consumeIssueOperation(issue);
|
||||||
this.statistics?.incrementFetchedItemsEventsCount();
|
this._statistics?.incrementFetchedItemsEventsCount();
|
||||||
const options = this.client.rest.issues.listEvents.endpoint.merge({
|
const options = this.client.issues.listEvents.endpoint.merge({
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
per_page: 100,
|
per_page: 100,
|
||||||
@@ -584,9 +537,7 @@ export class IssuesProcessor {
|
|||||||
const reversedEvents = events.reverse();
|
const reversedEvents = events.reverse();
|
||||||
|
|
||||||
const staleLabeledEvent = reversedEvents.find(
|
const staleLabeledEvent = reversedEvents.find(
|
||||||
event =>
|
event => event.event === 'labeled' && cleanLabel(event.label.name) === cleanLabel(label)
|
||||||
event.event === 'labeled' &&
|
|
||||||
cleanLabel(event.label.name) === cleanLabel(label)
|
|
||||||
);
|
);
|
||||||
|
|
||||||
if (!staleLabeledEvent) {
|
if (!staleLabeledEvent) {
|
||||||
@@ -597,25 +548,6 @@ export class IssuesProcessor {
|
|||||||
return staleLabeledEvent.created_at;
|
return staleLabeledEvent.created_at;
|
||||||
}
|
}
|
||||||
|
|
||||||
async getPullRequest(issue: Issue): Promise<IPullRequest | undefined | void> {
|
|
||||||
const issueLogger: IssueLogger = new IssueLogger(issue);
|
|
||||||
|
|
||||||
try {
|
|
||||||
this._consumeIssueOperation(issue);
|
|
||||||
this.statistics?.incrementFetchedPullRequestsCount();
|
|
||||||
|
|
||||||
const pullRequest = await this.client.rest.pulls.get({
|
|
||||||
owner: context.repo.owner,
|
|
||||||
repo: context.repo.repo,
|
|
||||||
pull_number: issue.number
|
|
||||||
});
|
|
||||||
|
|
||||||
return pullRequest.data;
|
|
||||||
} catch (error) {
|
|
||||||
issueLogger.error(`Error when getting this $$type: ${error.message}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// handle all of the stale issue logic when we find a stale issue
|
// handle all of the stale issue logic when we find a stale issue
|
||||||
private async _processStaleIssue(
|
private async _processStaleIssue(
|
||||||
issue: Issue,
|
issue: Issue,
|
||||||
@@ -633,15 +565,13 @@ export class IssuesProcessor {
|
|||||||
`$$type marked stale on: ${LoggerService.cyan(markedStaleOn)}`
|
`$$type marked stale on: ${LoggerService.cyan(markedStaleOn)}`
|
||||||
);
|
);
|
||||||
|
|
||||||
const issueHasCommentsSinceStale: boolean = await this._hasCommentsSince(
|
const issueHasComments: boolean = await this._hasCommentsSince(
|
||||||
issue,
|
issue,
|
||||||
markedStaleOn,
|
markedStaleOn,
|
||||||
staleMessage
|
staleMessage
|
||||||
);
|
);
|
||||||
issueLogger.info(
|
issueLogger.info(
|
||||||
`$$type has been commented on: ${LoggerService.cyan(
|
`$$type has been commented on: ${LoggerService.cyan(issueHasComments)}`
|
||||||
issueHasCommentsSinceStale
|
|
||||||
)}`
|
|
||||||
);
|
);
|
||||||
|
|
||||||
const daysBeforeClose: number = issue.isPullRequest
|
const daysBeforeClose: number = issue.isPullRequest
|
||||||
@@ -652,6 +582,14 @@ export class IssuesProcessor {
|
|||||||
`Days before $$type close: ${LoggerService.cyan(daysBeforeClose)}`
|
`Days before $$type close: ${LoggerService.cyan(daysBeforeClose)}`
|
||||||
);
|
);
|
||||||
|
|
||||||
|
const issueHasUpdate: boolean = IssuesProcessor._updatedSince(
|
||||||
|
issue.updated_at,
|
||||||
|
daysBeforeClose
|
||||||
|
);
|
||||||
|
issueLogger.info(
|
||||||
|
`$$type has been updated: ${LoggerService.cyan(issueHasUpdate)}`
|
||||||
|
);
|
||||||
|
|
||||||
const shouldRemoveStaleWhenUpdated: boolean =
|
const shouldRemoveStaleWhenUpdated: boolean =
|
||||||
this._shouldRemoveStaleWhenUpdated(issue);
|
this._shouldRemoveStaleWhenUpdated(issue);
|
||||||
|
|
||||||
@@ -669,32 +607,10 @@ export class IssuesProcessor {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (issue.markedStaleThisRun) {
|
|
||||||
issueLogger.info(`marked stale this run, so don't check for updates`);
|
|
||||||
}
|
|
||||||
|
|
||||||
// The issue.updated_at and markedStaleOn are not always exactly in sync (they can be off by a second or 2)
|
|
||||||
// isDateMoreRecentThan makes sure they are not the same date within a certain tolerance (15 seconds in this case)
|
|
||||||
const issueHasUpdateSinceStale = isDateMoreRecentThan(
|
|
||||||
new Date(issue.updated_at),
|
|
||||||
new Date(markedStaleOn),
|
|
||||||
15
|
|
||||||
);
|
|
||||||
|
|
||||||
issueLogger.info(
|
|
||||||
`$$type has been updated since it was marked stale: ${LoggerService.cyan(
|
|
||||||
issueHasUpdateSinceStale
|
|
||||||
)}`
|
|
||||||
);
|
|
||||||
|
|
||||||
// Should we un-stale this issue?
|
// Should we un-stale this issue?
|
||||||
if (
|
if (shouldRemoveStaleWhenUpdated && issueHasComments) {
|
||||||
shouldRemoveStaleWhenUpdated &&
|
|
||||||
(issueHasUpdateSinceStale || issueHasCommentsSinceStale) &&
|
|
||||||
!issue.markedStaleThisRun
|
|
||||||
) {
|
|
||||||
issueLogger.info(
|
issueLogger.info(
|
||||||
`Remove the stale label since the $$type has been updated and the workflow should remove the stale label when updated`
|
`Remove the stale label since the $$type has a comment and the workflow should remove the stale label when updated`
|
||||||
);
|
);
|
||||||
await this._removeStaleLabel(issue, staleLabel);
|
await this._removeStaleLabel(issue, staleLabel);
|
||||||
|
|
||||||
@@ -712,17 +628,7 @@ export class IssuesProcessor {
|
|||||||
return; // Nothing to do because we aren't closing stale issues
|
return; // Nothing to do because we aren't closing stale issues
|
||||||
}
|
}
|
||||||
|
|
||||||
const issueHasUpdateInCloseWindow: boolean = IssuesProcessor._updatedSince(
|
if (!issueHasComments && !issueHasUpdate) {
|
||||||
issue.updated_at,
|
|
||||||
daysBeforeClose
|
|
||||||
);
|
|
||||||
issueLogger.info(
|
|
||||||
`$$type has been updated in the last ${daysBeforeClose} days: ${LoggerService.cyan(
|
|
||||||
issueHasUpdateInCloseWindow
|
|
||||||
)}`
|
|
||||||
);
|
|
||||||
|
|
||||||
if (!issueHasCommentsSinceStale && !issueHasUpdateInCloseWindow) {
|
|
||||||
issueLogger.info(
|
issueLogger.info(
|
||||||
`Closing $$type because it was last updated on: ${LoggerService.cyan(
|
`Closing $$type because it was last updated on: ${LoggerService.cyan(
|
||||||
issue.updated_at
|
issue.updated_at
|
||||||
@@ -734,14 +640,14 @@ export class IssuesProcessor {
|
|||||||
issueLogger.info(
|
issueLogger.info(
|
||||||
`Deleting the branch since the option ${issueLogger.createOptionLink(
|
`Deleting the branch since the option ${issueLogger.createOptionLink(
|
||||||
Option.DeleteBranch
|
Option.DeleteBranch
|
||||||
)} is enabled`
|
)} was specified`
|
||||||
);
|
);
|
||||||
await this._deleteBranch(issue);
|
await this._deleteBranch(issue);
|
||||||
this.deletedBranchIssues.push(issue);
|
this.deletedBranchIssues.push(issue);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
issueLogger.info(
|
issueLogger.info(
|
||||||
`Stale $$type is not old enough to close yet (hasComments? ${issueHasCommentsSinceStale}, hasUpdate? ${issueHasUpdateInCloseWindow})`
|
`Stale $$type is not old enough to close yet (hasComments? ${issueHasComments}, hasUpdate? ${issueHasUpdate})`
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -763,12 +669,12 @@ export class IssuesProcessor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// find any comments since the date
|
// find any comments since the date
|
||||||
const comments = await this.listIssueComments(issue, sinceDate);
|
const comments = await this.listIssueComments(issue.number, sinceDate);
|
||||||
|
|
||||||
const filteredComments = comments.filter(
|
const filteredComments = comments.filter(
|
||||||
comment =>
|
comment =>
|
||||||
comment.user?.type === 'User' &&
|
comment.user.type === 'User' &&
|
||||||
comment.body?.toLowerCase() !== staleMessage.toLowerCase()
|
comment.body.toLowerCase() !== staleMessage.toLowerCase()
|
||||||
);
|
);
|
||||||
|
|
||||||
issueLogger.info(
|
issueLogger.info(
|
||||||
@@ -801,10 +707,10 @@ export class IssuesProcessor {
|
|||||||
if (!skipMessage) {
|
if (!skipMessage) {
|
||||||
try {
|
try {
|
||||||
this._consumeIssueOperation(issue);
|
this._consumeIssueOperation(issue);
|
||||||
this.statistics?.incrementAddedItemsComment(issue);
|
this._statistics?.incrementAddedItemsComment(issue);
|
||||||
|
|
||||||
if (!this.options.debugOnly) {
|
if (!this.options.debugOnly) {
|
||||||
await this.client.rest.issues.createComment({
|
await this.client.issues.createComment({
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
issue_number: issue.number,
|
issue_number: issue.number,
|
||||||
@@ -818,11 +724,11 @@ export class IssuesProcessor {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
this._consumeIssueOperation(issue);
|
this._consumeIssueOperation(issue);
|
||||||
this.statistics?.incrementAddedItemsLabel(issue);
|
this._statistics?.incrementAddedItemsLabel(issue);
|
||||||
this.statistics?.incrementStaleItemsCount(issue);
|
this._statistics?.incrementStaleItemsCount(issue);
|
||||||
|
|
||||||
if (!this.options.debugOnly) {
|
if (!this.options.debugOnly) {
|
||||||
await this.client.rest.issues.addLabels({
|
await this.client.issues.addLabels({
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
issue_number: issue.number,
|
issue_number: issue.number,
|
||||||
@@ -848,11 +754,10 @@ export class IssuesProcessor {
|
|||||||
if (closeMessage) {
|
if (closeMessage) {
|
||||||
try {
|
try {
|
||||||
this._consumeIssueOperation(issue);
|
this._consumeIssueOperation(issue);
|
||||||
this.statistics?.incrementAddedItemsComment(issue);
|
this._statistics?.incrementAddedItemsComment(issue);
|
||||||
this.addedCloseCommentIssues.push(issue);
|
|
||||||
|
|
||||||
if (!this.options.debugOnly) {
|
if (!this.options.debugOnly) {
|
||||||
await this.client.rest.issues.createComment({
|
await this.client.issues.createComment({
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
issue_number: issue.number,
|
issue_number: issue.number,
|
||||||
@@ -867,10 +772,10 @@ export class IssuesProcessor {
|
|||||||
if (closeLabel) {
|
if (closeLabel) {
|
||||||
try {
|
try {
|
||||||
this._consumeIssueOperation(issue);
|
this._consumeIssueOperation(issue);
|
||||||
this.statistics?.incrementAddedItemsLabel(issue);
|
this._statistics?.incrementAddedItemsLabel(issue);
|
||||||
|
|
||||||
if (!this.options.debugOnly) {
|
if (!this.options.debugOnly) {
|
||||||
await this.client.rest.issues.addLabels({
|
await this.client.issues.addLabels({
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
issue_number: issue.number,
|
issue_number: issue.number,
|
||||||
@@ -884,15 +789,14 @@ export class IssuesProcessor {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
this._consumeIssueOperation(issue);
|
this._consumeIssueOperation(issue);
|
||||||
this.statistics?.incrementClosedItemsCount(issue);
|
this._statistics?.incrementClosedItemsCount(issue);
|
||||||
|
|
||||||
if (!this.options.debugOnly) {
|
if (!this.options.debugOnly) {
|
||||||
await this.client.rest.issues.update({
|
await this.client.issues.update({
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
issue_number: issue.number,
|
issue_number: issue.number,
|
||||||
state: 'closed',
|
state: 'closed'
|
||||||
state_reason: this.options.closeIssueReason || undefined
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
@@ -900,18 +804,34 @@ export class IssuesProcessor {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private async _getPullRequest(
|
||||||
|
issue: Issue
|
||||||
|
): Promise<IPullRequest | undefined | void> {
|
||||||
|
const issueLogger: IssueLogger = new IssueLogger(issue);
|
||||||
|
|
||||||
|
try {
|
||||||
|
this._consumeIssueOperation(issue);
|
||||||
|
this._statistics?.incrementFetchedPullRequestsCount();
|
||||||
|
|
||||||
|
const pullRequest = await this.client.pulls.get({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
pull_number: issue.number
|
||||||
|
});
|
||||||
|
|
||||||
|
return pullRequest.data;
|
||||||
|
} catch (error) {
|
||||||
|
issueLogger.error(`Error when getting this $$type: ${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Delete the branch on closed pull request
|
// Delete the branch on closed pull request
|
||||||
private async _deleteBranch(issue: Issue): Promise<void> {
|
private async _deleteBranch(issue: Issue): Promise<void> {
|
||||||
const issueLogger: IssueLogger = new IssueLogger(issue);
|
const issueLogger: IssueLogger = new IssueLogger(issue);
|
||||||
|
|
||||||
issueLogger.info(`Delete
|
issueLogger.info(`Delete branch from closed $$type - ${issue.title}`);
|
||||||
branch from closed $
|
|
||||||
$type
|
|
||||||
-
|
|
||||||
${issue.title}`);
|
|
||||||
|
|
||||||
const pullRequest: IPullRequest | undefined | void =
|
const pullRequest = await this._getPullRequest(issue);
|
||||||
await this.getPullRequest(issue);
|
|
||||||
|
|
||||||
if (!pullRequest) {
|
if (!pullRequest) {
|
||||||
issueLogger.info(
|
issueLogger.info(
|
||||||
@@ -927,10 +847,10 @@ export class IssuesProcessor {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
this._consumeIssueOperation(issue);
|
this._consumeIssueOperation(issue);
|
||||||
this.statistics?.incrementDeletedBranchesCount();
|
this._statistics?.incrementDeletedBranchesCount();
|
||||||
|
|
||||||
if (!this.options.debugOnly) {
|
if (!this.options.debugOnly) {
|
||||||
await this.client.rest.git.deleteRef({
|
await this.client.git.deleteRef({
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
ref: `heads/${branch}`
|
ref: `heads/${branch}`
|
||||||
@@ -962,10 +882,10 @@ export class IssuesProcessor {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
this._consumeIssueOperation(issue);
|
this._consumeIssueOperation(issue);
|
||||||
this.statistics?.incrementDeletedItemsLabelsCount(issue);
|
this._statistics?.incrementDeletedItemsLabelsCount(issue);
|
||||||
|
|
||||||
if (!this.options.debugOnly) {
|
if (!this.options.debugOnly) {
|
||||||
await this.client.rest.issues.removeLabel({
|
await this.client.issues.removeLabel({
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
issue_number: issue.number,
|
issue_number: issue.number,
|
||||||
@@ -1025,10 +945,6 @@ export class IssuesProcessor {
|
|||||||
return this.options.onlyLabels;
|
return this.options.onlyLabels;
|
||||||
}
|
}
|
||||||
|
|
||||||
private _isIncludeOnlyAssigned(issue: Issue): boolean {
|
|
||||||
return this.options.includeOnlyAssigned && !issue.hasAssignees;
|
|
||||||
}
|
|
||||||
|
|
||||||
private _getAnyOfLabels(issue: Issue): string {
|
private _getAnyOfLabels(issue: Issue): string {
|
||||||
if (issue.isPullRequest) {
|
if (issue.isPullRequest) {
|
||||||
if (this.options.anyOfPrLabels !== '') {
|
if (this.options.anyOfPrLabels !== '') {
|
||||||
@@ -1099,10 +1015,10 @@ export class IssuesProcessor {
|
|||||||
this.addedLabelIssues.push(issue);
|
this.addedLabelIssues.push(issue);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
this._consumeIssueOperation(issue);
|
this.operations.consumeOperation();
|
||||||
this.statistics?.incrementAddedItemsLabel(issue);
|
this._statistics?.incrementAddedItemsLabel(issue);
|
||||||
if (!this.options.debugOnly) {
|
if (!this.options.debugOnly) {
|
||||||
await this.client.rest.issues.addLabels({
|
await this.client.issues.addLabels({
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
issue_number: issue.number,
|
issue_number: issue.number,
|
||||||
@@ -1127,7 +1043,7 @@ export class IssuesProcessor {
|
|||||||
);
|
);
|
||||||
|
|
||||||
await this._removeLabel(issue, staleLabel);
|
await this._removeLabel(issue, staleLabel);
|
||||||
this.statistics?.incrementUndoStaleItemsCount(issue);
|
this._statistics?.incrementUndoStaleItemsCount(issue);
|
||||||
}
|
}
|
||||||
|
|
||||||
private async _removeCloseLabel(
|
private async _removeCloseLabel(
|
||||||
@@ -1164,7 +1080,7 @@ export class IssuesProcessor {
|
|||||||
);
|
);
|
||||||
|
|
||||||
await this._removeLabel(issue, closeLabel, true);
|
await this._removeLabel(issue, closeLabel, true);
|
||||||
this.statistics?.incrementDeletedCloseItemsLabelsCount(issue);
|
this._statistics?.incrementDeletedCloseItemsLabelsCount(issue);
|
||||||
} else {
|
} else {
|
||||||
issueLogger.info(
|
issueLogger.info(
|
||||||
LoggerService.white('└──'),
|
LoggerService.white('└──'),
|
||||||
|
|||||||
@@ -9,28 +9,28 @@ interface IGroupValue {
|
|||||||
|
|
||||||
export class Statistics {
|
export class Statistics {
|
||||||
private readonly _logger: Logger = new Logger();
|
private readonly _logger: Logger = new Logger();
|
||||||
processedIssuesCount = 0;
|
private _processedIssuesCount = 0;
|
||||||
processedPullRequestsCount = 0;
|
private _processedPullRequestsCount = 0;
|
||||||
staleIssuesCount = 0;
|
private _staleIssuesCount = 0;
|
||||||
stalePullRequestsCount = 0;
|
private _stalePullRequestsCount = 0;
|
||||||
undoStaleIssuesCount = 0;
|
private _undoStaleIssuesCount = 0;
|
||||||
undoStalePullRequestsCount = 0;
|
private _undoStalePullRequestsCount = 0;
|
||||||
operationsCount = 0;
|
private _operationsCount = 0;
|
||||||
closedIssuesCount = 0;
|
private _closedIssuesCount = 0;
|
||||||
closedPullRequestsCount = 0;
|
private _closedPullRequestsCount = 0;
|
||||||
deletedIssuesLabelsCount = 0;
|
private _deletedIssuesLabelsCount = 0;
|
||||||
deletedPullRequestsLabelsCount = 0;
|
private _deletedPullRequestsLabelsCount = 0;
|
||||||
deletedCloseIssuesLabelsCount = 0;
|
private _deletedCloseIssuesLabelsCount = 0;
|
||||||
deletedClosePullRequestsLabelsCount = 0;
|
private _deletedClosePullRequestsLabelsCount = 0;
|
||||||
deletedBranchesCount = 0;
|
private _deletedBranchesCount = 0;
|
||||||
addedIssuesLabelsCount = 0;
|
private _addedIssuesLabelsCount = 0;
|
||||||
addedPullRequestsLabelsCount = 0;
|
private _addedPullRequestsLabelsCount = 0;
|
||||||
addedIssuesCommentsCount = 0;
|
private _addedIssuesCommentsCount = 0;
|
||||||
addedPullRequestsCommentsCount = 0;
|
private _addedPullRequestsCommentsCount = 0;
|
||||||
fetchedItemsCount = 0;
|
private _fetchedItemsCount = 0;
|
||||||
fetchedItemsEventsCount = 0;
|
private _fetchedItemsEventsCount = 0;
|
||||||
fetchedItemsCommentsCount = 0;
|
private _fetchedItemsCommentsCount = 0;
|
||||||
fetchedPullRequestsCount = 0;
|
private _fetchedPullRequestsCount = 0;
|
||||||
|
|
||||||
incrementProcessedItemsCount(
|
incrementProcessedItemsCount(
|
||||||
issue: Readonly<Issue>,
|
issue: Readonly<Issue>,
|
||||||
@@ -66,7 +66,7 @@ export class Statistics {
|
|||||||
}
|
}
|
||||||
|
|
||||||
setOperationsCount(operationsCount: Readonly<number>): Statistics {
|
setOperationsCount(operationsCount: Readonly<number>): Statistics {
|
||||||
this.operationsCount = operationsCount;
|
this._operationsCount = operationsCount;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -105,7 +105,7 @@ export class Statistics {
|
|||||||
}
|
}
|
||||||
|
|
||||||
incrementDeletedBranchesCount(increment: Readonly<number> = 1): Statistics {
|
incrementDeletedBranchesCount(increment: Readonly<number> = 1): Statistics {
|
||||||
this.deletedBranchesCount += increment;
|
this._deletedBranchesCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -133,7 +133,7 @@ export class Statistics {
|
|||||||
}
|
}
|
||||||
|
|
||||||
incrementFetchedItemsCount(increment: Readonly<number> = 1): Statistics {
|
incrementFetchedItemsCount(increment: Readonly<number> = 1): Statistics {
|
||||||
this.fetchedItemsCount += increment;
|
this._fetchedItemsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -141,7 +141,7 @@ export class Statistics {
|
|||||||
incrementFetchedItemsEventsCount(
|
incrementFetchedItemsEventsCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.fetchedItemsEventsCount += increment;
|
this._fetchedItemsEventsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -149,7 +149,7 @@ export class Statistics {
|
|||||||
incrementFetchedItemsCommentsCount(
|
incrementFetchedItemsCommentsCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.fetchedItemsCommentsCount += increment;
|
this._fetchedItemsCommentsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -157,7 +157,7 @@ export class Statistics {
|
|||||||
incrementFetchedPullRequestsCount(
|
incrementFetchedPullRequestsCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.fetchedPullRequestsCount += increment;
|
this._fetchedPullRequestsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -185,7 +185,7 @@ export class Statistics {
|
|||||||
private _incrementProcessedIssuesCount(
|
private _incrementProcessedIssuesCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.processedIssuesCount += increment;
|
this._processedIssuesCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -193,7 +193,7 @@ export class Statistics {
|
|||||||
private _incrementProcessedPullRequestsCount(
|
private _incrementProcessedPullRequestsCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.processedPullRequestsCount += increment;
|
this._processedPullRequestsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -201,7 +201,7 @@ export class Statistics {
|
|||||||
private _incrementStaleIssuesCount(
|
private _incrementStaleIssuesCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.staleIssuesCount += increment;
|
this._staleIssuesCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -209,7 +209,7 @@ export class Statistics {
|
|||||||
private _incrementStalePullRequestsCount(
|
private _incrementStalePullRequestsCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.stalePullRequestsCount += increment;
|
this._stalePullRequestsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -217,7 +217,7 @@ export class Statistics {
|
|||||||
private _incrementUndoStaleIssuesCount(
|
private _incrementUndoStaleIssuesCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.undoStaleIssuesCount += increment;
|
this._undoStaleIssuesCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -225,7 +225,7 @@ export class Statistics {
|
|||||||
private _incrementUndoStalePullRequestsCount(
|
private _incrementUndoStalePullRequestsCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.undoStalePullRequestsCount += increment;
|
this._undoStalePullRequestsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -233,7 +233,7 @@ export class Statistics {
|
|||||||
private _incrementClosedIssuesCount(
|
private _incrementClosedIssuesCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.closedIssuesCount += increment;
|
this._closedIssuesCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -241,7 +241,7 @@ export class Statistics {
|
|||||||
private _incrementClosedPullRequestsCount(
|
private _incrementClosedPullRequestsCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.closedPullRequestsCount += increment;
|
this._closedPullRequestsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -249,7 +249,7 @@ export class Statistics {
|
|||||||
private _incrementDeletedIssuesLabelsCount(
|
private _incrementDeletedIssuesLabelsCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.deletedIssuesLabelsCount += increment;
|
this._deletedIssuesLabelsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -257,7 +257,7 @@ export class Statistics {
|
|||||||
private _incrementDeletedPullRequestsLabelsCount(
|
private _incrementDeletedPullRequestsLabelsCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.deletedPullRequestsLabelsCount += increment;
|
this._deletedPullRequestsLabelsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -265,7 +265,7 @@ export class Statistics {
|
|||||||
private _incrementDeletedCloseIssuesLabelsCount(
|
private _incrementDeletedCloseIssuesLabelsCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.deletedCloseIssuesLabelsCount += increment;
|
this._deletedCloseIssuesLabelsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -273,7 +273,7 @@ export class Statistics {
|
|||||||
private _incrementDeletedClosePullRequestsLabelsCount(
|
private _incrementDeletedClosePullRequestsLabelsCount(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.deletedClosePullRequestsLabelsCount += increment;
|
this._deletedClosePullRequestsLabelsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -281,7 +281,7 @@ export class Statistics {
|
|||||||
private _incrementAddedIssuesLabel(
|
private _incrementAddedIssuesLabel(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.addedIssuesLabelsCount += increment;
|
this._addedIssuesLabelsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -289,7 +289,7 @@ export class Statistics {
|
|||||||
private _incrementAddedPullRequestsLabel(
|
private _incrementAddedPullRequestsLabel(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.addedPullRequestsLabelsCount += increment;
|
this._addedPullRequestsLabelsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -297,7 +297,7 @@ export class Statistics {
|
|||||||
private _incrementAddedIssuesComment(
|
private _incrementAddedIssuesComment(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.addedIssuesCommentsCount += increment;
|
this._addedIssuesCommentsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -305,7 +305,7 @@ export class Statistics {
|
|||||||
private _incrementAddedPullRequestsComment(
|
private _incrementAddedPullRequestsComment(
|
||||||
increment: Readonly<number> = 1
|
increment: Readonly<number> = 1
|
||||||
): Statistics {
|
): Statistics {
|
||||||
this.addedPullRequestsCommentsCount += increment;
|
this._addedPullRequestsCommentsCount += increment;
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -314,11 +314,11 @@ export class Statistics {
|
|||||||
this._logGroup('Processed items', [
|
this._logGroup('Processed items', [
|
||||||
{
|
{
|
||||||
name: 'Processed issues',
|
name: 'Processed issues',
|
||||||
count: this.processedIssuesCount
|
count: this._processedIssuesCount
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'Processed PRs',
|
name: 'Processed PRs',
|
||||||
count: this.processedPullRequestsCount
|
count: this._processedPullRequestsCount
|
||||||
}
|
}
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
@@ -327,11 +327,11 @@ export class Statistics {
|
|||||||
this._logGroup('New stale items', [
|
this._logGroup('New stale items', [
|
||||||
{
|
{
|
||||||
name: 'New stale issues',
|
name: 'New stale issues',
|
||||||
count: this.staleIssuesCount
|
count: this._staleIssuesCount
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'New stale PRs',
|
name: 'New stale PRs',
|
||||||
count: this.stalePullRequestsCount
|
count: this._stalePullRequestsCount
|
||||||
}
|
}
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
@@ -340,11 +340,11 @@ export class Statistics {
|
|||||||
this._logGroup('No longer stale items', [
|
this._logGroup('No longer stale items', [
|
||||||
{
|
{
|
||||||
name: 'No longer stale issues',
|
name: 'No longer stale issues',
|
||||||
count: this.undoStaleIssuesCount
|
count: this._undoStaleIssuesCount
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'No longer stale PRs',
|
name: 'No longer stale PRs',
|
||||||
count: this.undoStalePullRequestsCount
|
count: this._undoStalePullRequestsCount
|
||||||
}
|
}
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
@@ -353,11 +353,11 @@ export class Statistics {
|
|||||||
this._logGroup('Closed items', [
|
this._logGroup('Closed items', [
|
||||||
{
|
{
|
||||||
name: 'Closed issues',
|
name: 'Closed issues',
|
||||||
count: this.closedIssuesCount
|
count: this._closedIssuesCount
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'Closed PRs',
|
name: 'Closed PRs',
|
||||||
count: this.closedPullRequestsCount
|
count: this._closedPullRequestsCount
|
||||||
}
|
}
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
@@ -366,11 +366,11 @@ export class Statistics {
|
|||||||
this._logGroup('Deleted items labels', [
|
this._logGroup('Deleted items labels', [
|
||||||
{
|
{
|
||||||
name: 'Deleted issues labels',
|
name: 'Deleted issues labels',
|
||||||
count: this.deletedIssuesLabelsCount
|
count: this._deletedIssuesLabelsCount
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'Deleted PRs labels',
|
name: 'Deleted PRs labels',
|
||||||
count: this.deletedPullRequestsLabelsCount
|
count: this._deletedPullRequestsLabelsCount
|
||||||
}
|
}
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
@@ -379,28 +379,28 @@ export class Statistics {
|
|||||||
this._logGroup('Deleted close items labels', [
|
this._logGroup('Deleted close items labels', [
|
||||||
{
|
{
|
||||||
name: 'Deleted close issues labels',
|
name: 'Deleted close issues labels',
|
||||||
count: this.deletedCloseIssuesLabelsCount
|
count: this._deletedCloseIssuesLabelsCount
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'Deleted close PRs labels',
|
name: 'Deleted close PRs labels',
|
||||||
count: this.deletedClosePullRequestsLabelsCount
|
count: this._deletedClosePullRequestsLabelsCount
|
||||||
}
|
}
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
private _logDeletedBranchesCount(): void {
|
private _logDeletedBranchesCount(): void {
|
||||||
this._logCount('Deleted branches', this.deletedBranchesCount);
|
this._logCount('Deleted branches', this._deletedBranchesCount);
|
||||||
}
|
}
|
||||||
|
|
||||||
private _logAddedIssuesAndPullRequestsLabelsCount(): void {
|
private _logAddedIssuesAndPullRequestsLabelsCount(): void {
|
||||||
this._logGroup('Added items labels', [
|
this._logGroup('Added items labels', [
|
||||||
{
|
{
|
||||||
name: 'Added issues labels',
|
name: 'Added issues labels',
|
||||||
count: this.addedIssuesLabelsCount
|
count: this._addedIssuesLabelsCount
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'Added PRs labels',
|
name: 'Added PRs labels',
|
||||||
count: this.addedPullRequestsLabelsCount
|
count: this._addedPullRequestsLabelsCount
|
||||||
}
|
}
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
@@ -409,33 +409,33 @@ export class Statistics {
|
|||||||
this._logGroup('Added items comments', [
|
this._logGroup('Added items comments', [
|
||||||
{
|
{
|
||||||
name: 'Added issues comments',
|
name: 'Added issues comments',
|
||||||
count: this.addedIssuesCommentsCount
|
count: this._addedIssuesCommentsCount
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'Added PRs comments',
|
name: 'Added PRs comments',
|
||||||
count: this.addedPullRequestsCommentsCount
|
count: this._addedPullRequestsCommentsCount
|
||||||
}
|
}
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
private _logFetchedItemsCount(): void {
|
private _logFetchedItemsCount(): void {
|
||||||
this._logCount('Fetched items', this.fetchedItemsCount);
|
this._logCount('Fetched items', this._fetchedItemsCount);
|
||||||
}
|
}
|
||||||
|
|
||||||
private _logFetchedItemsEventsCount(): void {
|
private _logFetchedItemsEventsCount(): void {
|
||||||
this._logCount('Fetched items events', this.fetchedItemsEventsCount);
|
this._logCount('Fetched items events', this._fetchedItemsEventsCount);
|
||||||
}
|
}
|
||||||
|
|
||||||
private _logFetchedItemsCommentsCount(): void {
|
private _logFetchedItemsCommentsCount(): void {
|
||||||
this._logCount('Fetched items comments', this.fetchedItemsCommentsCount);
|
this._logCount('Fetched items comments', this._fetchedItemsCommentsCount);
|
||||||
}
|
}
|
||||||
|
|
||||||
private _logFetchedPullRequestsCount(): void {
|
private _logFetchedPullRequestsCount(): void {
|
||||||
this._logCount('Fetched pull requests', this.fetchedPullRequestsCount);
|
this._logCount('Fetched pull requests', this._fetchedPullRequestsCount);
|
||||||
}
|
}
|
||||||
|
|
||||||
private _logOperationsCount(): void {
|
private _logOperationsCount(): void {
|
||||||
this._logCount('Operations performed', this.operationsCount);
|
this._logCount('Operations performed', this._operationsCount);
|
||||||
}
|
}
|
||||||
|
|
||||||
private _logCount(name: Readonly<string>, count: Readonly<number>): void {
|
private _logCount(name: Readonly<string>, count: Readonly<number>): void {
|
||||||
|
|||||||
@@ -42,10 +42,5 @@ export enum Option {
|
|||||||
ExemptAllPrAssignees = 'exempt-all-pr-assignees',
|
ExemptAllPrAssignees = 'exempt-all-pr-assignees',
|
||||||
EnableStatistics = 'enable-statistics',
|
EnableStatistics = 'enable-statistics',
|
||||||
LabelsToRemoveWhenUnstale = 'labels-to-remove-when-unstale',
|
LabelsToRemoveWhenUnstale = 'labels-to-remove-when-unstale',
|
||||||
LabelsToAddWhenUnstale = 'labels-to-add-when-unstale',
|
LabelsToAddWhenUnstale = 'labels-to-add-when-unstale'
|
||||||
IgnoreUpdates = 'ignore-updates',
|
|
||||||
IgnoreIssueUpdates = 'ignore-issue-updates',
|
|
||||||
IgnorePrUpdates = 'ignore-pr-updates',
|
|
||||||
ExemptDraftPr = 'exempt-draft-pr',
|
|
||||||
CloseIssueReason = 'close-issue-reason'
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import deburr from 'lodash.deburr';
|
import deburr from 'lodash.deburr';
|
||||||
import {CleanLabel} from '../types/clean-label';
|
import { CleanLabel } from '../types/clean-label';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @description
|
* @description
|
||||||
@@ -9,6 +9,6 @@ import {CleanLabel} from '../types/clean-label';
|
|||||||
*
|
*
|
||||||
* @return {string} A lowercased, deburred version of the passed in label
|
* @return {string} A lowercased, deburred version of the passed in label
|
||||||
*/
|
*/
|
||||||
export function cleanLabel(label?: Readonly<string>): CleanLabel {
|
export function cleanLabel(label: Readonly<string>): CleanLabel {
|
||||||
return deburr(label?.toLowerCase());
|
return deburr(label.toLowerCase());
|
||||||
}
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import {isDateEqualTo, isDateMoreRecentThan} from './is-date-more-recent-than';
|
import {isDateMoreRecentThan} from './is-date-more-recent-than';
|
||||||
|
|
||||||
describe('isDateMoreRecentThan()', (): void => {
|
describe('isDateMoreRecentThan()', (): void => {
|
||||||
let date: Date;
|
let date: Date;
|
||||||
@@ -48,68 +48,4 @@ describe('isDateMoreRecentThan()', (): void => {
|
|||||||
expect(result).toStrictEqual(true);
|
expect(result).toStrictEqual(true);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('date equality', (): void => {
|
|
||||||
it('should correctly compare a before date outside tolerance', (): void => {
|
|
||||||
const aDate = new Date('2022-09-09T13:00:00');
|
|
||||||
const otherDate = new Date('2022-09-09T14:00:00');
|
|
||||||
expect(isDateEqualTo(aDate, otherDate, 60)).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should correctly compare a before date inside tolerance', (): void => {
|
|
||||||
const aDate = new Date('2022-09-09T13:00:00');
|
|
||||||
const otherDate = new Date('2022-09-09T13:00:42');
|
|
||||||
expect(isDateEqualTo(aDate, otherDate, 60)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should correctly compare an after date outside tolerance', (): void => {
|
|
||||||
const aDate = new Date('2022-09-09T13:00:00');
|
|
||||||
const otherDate = new Date('2022-09-09T12:00:00');
|
|
||||||
expect(isDateEqualTo(aDate, otherDate, 60)).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should correctly compare an after date inside tolerance', (): void => {
|
|
||||||
const aDate = new Date('2022-09-09T13:00:00');
|
|
||||||
const otherDate = new Date('2022-09-09T12:59:42');
|
|
||||||
expect(isDateEqualTo(aDate, otherDate, 60)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should correctly compare an exactly equal date', (): void => {
|
|
||||||
const aDate = new Date('2022-09-09T13:00:00');
|
|
||||||
const otherDate = new Date('2022-09-09T13:00:00');
|
|
||||||
expect(isDateEqualTo(aDate, otherDate, 60)).toBe(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('date comparison with tolerances', (): void => {
|
|
||||||
it('should correctly compare a before date outside tolerance', (): void => {
|
|
||||||
const aDate = new Date('2022-09-09T13:00:00');
|
|
||||||
const otherDate = new Date('2022-09-09T14:00:00');
|
|
||||||
expect(isDateMoreRecentThan(aDate, otherDate)).toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should correctly compare a before date inside tolerance', (): void => {
|
|
||||||
const aDate = new Date('2022-09-09T13:00:00');
|
|
||||||
const otherDate = new Date('2022-09-09T13:00:42');
|
|
||||||
expect(isDateMoreRecentThan(aDate, otherDate, 60)).toBe(false); // considered equal here
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should correctly compare an after date outside tolerance', (): void => {
|
|
||||||
const aDate = new Date('2022-09-09T13:00:00');
|
|
||||||
const otherDate = new Date('2022-09-09T12:00:00');
|
|
||||||
expect(isDateMoreRecentThan(aDate, otherDate, 60)).toBe(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should correctly compare an after date inside tolerance', (): void => {
|
|
||||||
const aDate = new Date('2022-09-09T13:00:00');
|
|
||||||
const otherDate = new Date('2022-09-09T12:59:42');
|
|
||||||
expect(isDateMoreRecentThan(aDate, otherDate, 60)).toBe(false); // considered equal here
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should correctly compare an exactly equal date', (): void => {
|
|
||||||
const aDate = new Date('2022-09-09T13:00:00');
|
|
||||||
const otherDate = new Date('2022-09-09T13:00:00');
|
|
||||||
expect(isDateMoreRecentThan(aDate, otherDate, 60)).toBe(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,31 +1,6 @@
|
|||||||
/// returns false if the dates are equal within the `equalityToleranceInSeconds` number of seconds
|
|
||||||
/// otherwise returns true if `comparedDate` is after `date`
|
|
||||||
|
|
||||||
export function isDateMoreRecentThan(
|
export function isDateMoreRecentThan(
|
||||||
date: Readonly<Date>,
|
date: Readonly<Date>,
|
||||||
comparedDate: Readonly<Date>,
|
comparedDate: Readonly<Date>
|
||||||
equalityToleranceInSeconds = 0
|
|
||||||
): boolean {
|
): boolean {
|
||||||
if (equalityToleranceInSeconds > 0) {
|
|
||||||
const areDatesEqual = isDateEqualTo(
|
|
||||||
date,
|
|
||||||
comparedDate,
|
|
||||||
equalityToleranceInSeconds
|
|
||||||
);
|
|
||||||
|
|
||||||
return !areDatesEqual && date > comparedDate;
|
|
||||||
}
|
|
||||||
|
|
||||||
return date > comparedDate;
|
return date > comparedDate;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function isDateEqualTo(
|
|
||||||
date: Date,
|
|
||||||
otherDate: Date,
|
|
||||||
toleranceInSeconds: number
|
|
||||||
): boolean {
|
|
||||||
const timestamp = date.getTime();
|
|
||||||
const otherTimestamp = otherDate.getTime();
|
|
||||||
const deltaInSeconds = Math.abs(timestamp - otherTimestamp) / 1000;
|
|
||||||
return deltaInSeconds <= toleranceInSeconds;
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,11 +1,3 @@
|
|||||||
// @todo improve to include the notion of team?
|
export interface IAssignee {
|
||||||
interface IAssignee {
|
login: string;
|
||||||
type: string;
|
}
|
||||||
}
|
|
||||||
|
|
||||||
export interface IUserAssignee extends IAssignee {
|
|
||||||
login: string;
|
|
||||||
type: 'User' | string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type Assignee = IUserAssignee;
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import {IUser} from './user';
|
import {IUser} from './user';
|
||||||
|
|
||||||
export interface IComment {
|
export interface IComment {
|
||||||
user: IUser | null;
|
user: IUser;
|
||||||
body?: string;
|
body: string;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,19 +1,17 @@
|
|||||||
import {IsoDateString} from '../types/iso-date-string';
|
import {IsoDateString} from '../types/iso-date-string';
|
||||||
import {Assignee} from './assignee';
|
import {IAssignee} from './assignee';
|
||||||
import {ILabel} from './label';
|
import {ILabel} from './label';
|
||||||
import {IMilestone} from './milestone';
|
import {IMilestone} from './milestone';
|
||||||
import {components} from '@octokit/openapi-types';
|
|
||||||
export interface IIssue {
|
export interface IIssue {
|
||||||
title: string;
|
title: string;
|
||||||
number: number;
|
number: number;
|
||||||
created_at: IsoDateString;
|
created_at: IsoDateString;
|
||||||
updated_at: IsoDateString;
|
updated_at: IsoDateString;
|
||||||
labels: ILabel[];
|
labels: ILabel[];
|
||||||
pull_request?: Object | null;
|
pull_request: Object | null | undefined;
|
||||||
state: string;
|
state: string;
|
||||||
locked: boolean;
|
locked: boolean;
|
||||||
milestone?: IMilestone | null;
|
milestone: IMilestone | undefined;
|
||||||
assignees?: Assignee[] | null;
|
assignees: IAssignee[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export type OctokitIssue = components['schemas']['issue'];
|
|
||||||
|
|||||||
@@ -47,10 +47,4 @@ export interface IIssuesProcessorOptions {
|
|||||||
enableStatistics: boolean;
|
enableStatistics: boolean;
|
||||||
labelsToRemoveWhenUnstale: string;
|
labelsToRemoveWhenUnstale: string;
|
||||||
labelsToAddWhenUnstale: string;
|
labelsToAddWhenUnstale: string;
|
||||||
ignoreUpdates: boolean;
|
|
||||||
ignoreIssueUpdates: boolean | undefined;
|
|
||||||
ignorePrUpdates: boolean | undefined;
|
|
||||||
exemptDraftPr: boolean;
|
|
||||||
closeIssueReason: string;
|
|
||||||
includeOnlyAssigned: boolean;
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
export interface ILabel {
|
export interface ILabel {
|
||||||
name?: string;
|
name: string;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,5 +3,4 @@ export interface IPullRequest {
|
|||||||
head: {
|
head: {
|
||||||
ref: string;
|
ref: string;
|
||||||
};
|
};
|
||||||
draft?: boolean;
|
|
||||||
}
|
}
|
||||||
|
|||||||
32
src/main.ts
32
src/main.ts
@@ -57,10 +57,10 @@ function _getAndValidateArgs(): IIssuesProcessorOptions {
|
|||||||
core.getInput('remove-stale-when-updated') === 'false'
|
core.getInput('remove-stale-when-updated') === 'false'
|
||||||
),
|
),
|
||||||
removeIssueStaleWhenUpdated: _toOptionalBoolean(
|
removeIssueStaleWhenUpdated: _toOptionalBoolean(
|
||||||
'remove-issue-stale-when-updated'
|
core.getInput('remove-issue-stale-when-updated')
|
||||||
),
|
),
|
||||||
removePrStaleWhenUpdated: _toOptionalBoolean(
|
removePrStaleWhenUpdated: _toOptionalBoolean(
|
||||||
'remove-pr-stale-when-updated'
|
core.getInput('remove-pr-stale-when-updated')
|
||||||
),
|
),
|
||||||
debugOnly: core.getInput('debug-only') === 'true',
|
debugOnly: core.getInput('debug-only') === 'true',
|
||||||
ascending: core.getInput('ascending') === 'true',
|
ascending: core.getInput('ascending') === 'true',
|
||||||
@@ -83,13 +83,7 @@ function _getAndValidateArgs(): IIssuesProcessorOptions {
|
|||||||
exemptAllPrAssignees: _toOptionalBoolean('exempt-all-pr-assignees'),
|
exemptAllPrAssignees: _toOptionalBoolean('exempt-all-pr-assignees'),
|
||||||
enableStatistics: core.getInput('enable-statistics') === 'true',
|
enableStatistics: core.getInput('enable-statistics') === 'true',
|
||||||
labelsToRemoveWhenUnstale: core.getInput('labels-to-remove-when-unstale'),
|
labelsToRemoveWhenUnstale: core.getInput('labels-to-remove-when-unstale'),
|
||||||
labelsToAddWhenUnstale: core.getInput('labels-to-add-when-unstale'),
|
labelsToAddWhenUnstale: core.getInput('labels-to-add-when-unstale')
|
||||||
ignoreUpdates: core.getInput('ignore-updates') === 'true',
|
|
||||||
ignoreIssueUpdates: _toOptionalBoolean('ignore-issue-updates'),
|
|
||||||
ignorePrUpdates: _toOptionalBoolean('ignore-pr-updates'),
|
|
||||||
exemptDraftPr: core.getInput('exempt-draft-pr') === 'true',
|
|
||||||
closeIssueReason: core.getInput('close-issue-reason'),
|
|
||||||
includeOnlyAssigned: core.getInput('include-only-assigned') === 'true'
|
|
||||||
};
|
};
|
||||||
|
|
||||||
for (const numberInput of [
|
for (const numberInput of [
|
||||||
@@ -115,15 +109,6 @@ function _getAndValidateArgs(): IIssuesProcessorOptions {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const validCloseReasons = ['', 'completed', 'not_planned'];
|
|
||||||
if (!validCloseReasons.includes(args.closeIssueReason)) {
|
|
||||||
const errorMessage = `Unrecognized close-issue-reason "${
|
|
||||||
args.closeIssueReason
|
|
||||||
}", valid values are: ${validCloseReasons.filter(Boolean).join(', ')}`;
|
|
||||||
core.setFailed(errorMessage);
|
|
||||||
throw new Error(errorMessage);
|
|
||||||
}
|
|
||||||
|
|
||||||
return args;
|
return args;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -135,17 +120,6 @@ async function processOutput(
|
|||||||
core.setOutput('closed-issues-prs', JSON.stringify(closedIssues));
|
core.setOutput('closed-issues-prs', JSON.stringify(closedIssues));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @description
|
|
||||||
* From an argument name, get the value as an optional boolean
|
|
||||||
* This is very useful for all the arguments that override others
|
|
||||||
* It will allow us to easily use the original one when the return value is `undefined`
|
|
||||||
* Which is different from `true` or `false` that consider the argument as set
|
|
||||||
*
|
|
||||||
* @param {Readonly<string>} argumentName The name of the argument to check
|
|
||||||
*
|
|
||||||
* @returns {boolean | undefined} The value matching the given argument name
|
|
||||||
*/
|
|
||||||
function _toOptionalBoolean(
|
function _toOptionalBoolean(
|
||||||
argumentName: Readonly<string>
|
argumentName: Readonly<string>
|
||||||
): boolean | undefined {
|
): boolean | undefined {
|
||||||
|
|||||||
Reference in New Issue
Block a user