Compare commits

...

23 Commits

Author SHA1 Message Date
Ross Brodbeck
c306dd9863 Add distribution to main branch 2020-04-13 14:09:37 -04:00
Ross Brodbeck
4449c02d54 Add linting 2020-04-13 14:05:37 -04:00
Ross Brodbeck
71bcc1ac0d remove husky 2020-04-13 13:34:41 -04:00
Ross Brodbeck
21ad1d6ae9 Remove older toolkit zips 2020-04-13 13:32:26 -04:00
Ross Brodbeck
c519c8b2ba Ignore .DS_Store 2020-04-13 13:31:46 -04:00
Ross Brodbeck
e8a07ea207 Update imports, fix packaging and build 2020-04-13 13:30:51 -04:00
Ross Brodbeck
3d5d474504 Merge pull request #22 from yuya-takeyama/only-labels-pr
Add only-labels option
2020-04-13 07:19:13 -04:00
Ross Brodbeck
54897a34f9 Fix labelsOnly description so it is easier to understand
Co-Authored-By: Stephan Miehe <49914758+stephanmiehe@users.noreply.github.com>
2020-04-13 07:17:15 -04:00
Ross Brodbeck
c5c8bac9c4 Merge pull request #16 from actions/dont-close-option
Add option to not close stale issues/prs
2020-04-13 07:12:39 -04:00
Ross Brodbeck
ee2e3ba115 Merge pull request #25 from actions/IAmHughes/update-docs
Update README.md example workflows to latest release version
2020-04-13 07:11:27 -04:00
Chris Patterson
0d6a8e5314 Merge pull request #26 from actions/ethomson/update_description
Update description
2019-12-10 11:22:42 -05:00
Chris Patterson
eb8d275a4a Merge pull request #29 from actions/add-syntax-highlighting
Add syntax highlighting to examples
2019-12-10 11:22:23 -05:00
Alberto Gimeno
c2f51ac751 Update README.md 2019-11-27 16:04:40 +01:00
Edward Thomson
d6c1b70646 Update description 2019-11-08 16:47:32 +00:00
Thomas Hughes
1a8e37e7ad Update README to latest release version 2019-11-01 13:43:25 +01:00
Yuya Takeyama
8588c16319 Add only-labels 2019-09-27 22:50:35 +09:00
Danny McCormick
b8e29997c6 Clean up 2019-09-05 09:57:15 -04:00
damccorm
2521dbb244 Add option to not close stale 2019-09-04 16:38:09 -04:00
Jeremy Epling
08796943dd Merge pull request #14 from actions/kaylangan-per-day
Example runs once per day instead of per hour
2019-08-29 14:52:07 -04:00
Kayla Ngan
ded3b10c18 Example runs once per day instead of per hour 2019-08-29 14:50:13 -04:00
Ryan Wilson-Perkin
9f69ef12ad Feature: Exempt labels from action (#11)
* Change name to isLabeled for re-use with "exempt"

* Add args for exempt labels

* Skip operation if labeled exempt

* Only check for exempt label if defined

Since the exempt label parameter is not required, we don't want to both
checking for it if it was not defined.

* Don't reduce operationsLeft if exempt

This variable just tracks the number of operations we're using to avoid
rate limiting. Since the exempt check wouldn't result in a rate-limited
request, we don't need to reduce the variable.

* Update the action.yml with new exempt values

* Update README with example of exempt labels

* Remove redundant defaults
2019-08-27 15:58:14 -04:00
Edward Thomson
cc7f3505fc Spelling fixes in action description (#7)
Fix typo 'iusses' -> 'issues'.  Also update 'prs' to 'pull requests'.
2019-08-19 14:34:16 -04:00
John Briggs
0cad222e9d Fix wasLastUpdatedBefore to be in days, not hours (#8)
The parameters and variables names make it seem like this is the intended behavior.
2019-08-19 14:28:41 -04:00
15 changed files with 28302 additions and 1551 deletions

3
.eslintignore Normal file
View File

@@ -0,0 +1,3 @@
dist/
lib/
node_modules/

55
.eslintrc.json Normal file
View File

@@ -0,0 +1,55 @@
{
"plugins": ["jest", "@typescript-eslint"],
"extends": ["plugin:github/es6"],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 9,
"sourceType": "module",
"project": "./tsconfig.json"
},
"rules": {
"eslint-comments/no-use": "off",
"import/no-namespace": "off",
"no-unused-vars": "off",
"@typescript-eslint/no-unused-vars": "error",
"@typescript-eslint/explicit-member-accessibility": ["error", {"accessibility": "no-public"}],
"@typescript-eslint/no-require-imports": "error",
"@typescript-eslint/array-type": "error",
"@typescript-eslint/await-thenable": "error",
"@typescript-eslint/ban-ts-ignore": "error",
"camelcase": "off",
"@typescript-eslint/class-name-casing": "error",
"@typescript-eslint/func-call-spacing": ["error", "never"],
"@typescript-eslint/generic-type-naming": ["error", "^[A-Z][A-Za-z]*$"],
"@typescript-eslint/no-array-constructor": "error",
"@typescript-eslint/no-empty-interface": "error",
"@typescript-eslint/no-explicit-any": "error",
"@typescript-eslint/no-extraneous-class": "error",
"@typescript-eslint/no-for-in-array": "error",
"@typescript-eslint/no-inferrable-types": "error",
"@typescript-eslint/no-misused-new": "error",
"@typescript-eslint/no-namespace": "error",
"@typescript-eslint/no-non-null-assertion": "warn",
"@typescript-eslint/no-object-literal-type-assertion": "error",
"@typescript-eslint/no-unnecessary-qualifier": "error",
"@typescript-eslint/no-unnecessary-type-assertion": "error",
"@typescript-eslint/no-useless-constructor": "error",
"@typescript-eslint/no-var-requires": "error",
"@typescript-eslint/prefer-for-of": "warn",
"@typescript-eslint/prefer-function-type": "warn",
"@typescript-eslint/prefer-includes": "error",
"@typescript-eslint/prefer-interface": "error",
"@typescript-eslint/prefer-string-starts-ends-with": "error",
"@typescript-eslint/promise-function-async": "error",
"@typescript-eslint/require-array-sort-compare": "error",
"@typescript-eslint/restrict-plus-operands": "error",
"semi": "off",
"@typescript-eslint/type-annotation-spacing": "error",
"@typescript-eslint/unbound-method": "error"
},
"env": {
"node": true,
"es6": true,
"jest/globals": true
}
}

1
.gitignore vendored
View File

@@ -1,3 +1,4 @@
.DS_Store
node_modules/
lib/
__tests__/runner/*

View File

@@ -7,17 +7,17 @@ Warns and then closes issues and PRs that have had no activity for a specified a
See [action.yml](./action.yml) For comprehensive list of options.
Basic:
```
```yaml
name: "Close stale issues"
on:
schedule:
- cron: "0 * * * *"
- cron: "0 0 * * *"
jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v1
- uses: actions/stale@v1.1.0
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'Message to comment on stale issues. If none provided, will not mark issues stale'
@@ -25,17 +25,17 @@ jobs:
```
Configure stale timeouts:
```
```yaml
name: "Close stale issues"
on:
schedule:
- cron: "0 * * * *"
- cron: "0 0 * * *"
jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v1
- uses: actions/stale@v1.1.0
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
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'
@@ -44,21 +44,23 @@ jobs:
```
Configure labels:
```
```yaml
name: "Close stale issues"
on:
schedule:
- cron: "0 * * * *"
- cron: "0 0 * * *"
jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v1
- uses: actions/stale@v1.1.0
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'Stale issue message'
stale-pr-message: 'Stale issue message'
stale-issue-label: 'no-issue-activity'
exempt-issue-label: 'awaiting-approval'
stale-pr-label: 'no-pr-activity'
exempt-pr-label: 'awaiting-approval'
```

View File

@@ -1,29 +1,36 @@
name: 'Close Stale Issues'
description: 'Action to close stale issues'
description: 'Close issues and pull requests with no recent activity'
author: 'GitHub'
inputs:
repo-token:
description: 'Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
description: 'Token for the repository. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
required: true
stale-issue-message:
description: 'The message to post on the issue when tagging it. If none provided, will not mark iusses stale.'
description: 'The message to post on the issue when tagging it. If none provided, will not mark issues stale.'
stale-pr-message:
description: 'The message to post on the pr when tagging it. If none provided, will not mark prs stale.'
description: 'The message to post on the pr when tagging it. If none provided, will not mark pull requests stale.'
days-before-stale:
description: 'The number of days old an issue can be before marking it stale'
default: 60
days-before-close:
description: 'The number of days to wait to close an issue or pr after it being marked stale'
description: 'The number of days to wait to close an issue or pull request after it being marked stale. Set to -1 to never close stale issues.'
default: 7
stale-issue-label:
description: 'The label to apply when an issue is stale'
default: 'Stale'
exempt-issue-label:
description: 'The label to apply when an issue is exempt from being marked stale'
stale-pr-label:
description: 'The label to apply when a pr is stale'
description: 'The label to apply when a pull request is stale'
default: 'Stale'
exempt-pr-label:
description: 'The label to apply when a pull request is exempt from being marked stale'
only-labels:
description: 'Only issues or pull requests with all of these labels are checked if stale. Defaults to `[]` (disabled)' and can be a comma-separated list of labels
default: ''
operations-per-run:
description: 'The maximum number of operations per run, used to control rate limiting'
default: 30
runs:
using: 'node12'
main: 'lib/main.js'
main: 'lib/main.js'

25456
dist/index.js vendored Normal file

File diff suppressed because it is too large Load Diff

4158
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{
"name": "stale-action",
"version": "1.0.0",
"version": "2.0.0",
"private": true,
"description": "Marks old issues and PRs as stale",
"main": "lib/main.js",
@@ -8,7 +8,10 @@
"build": "tsc",
"format": "prettier --write **/*.ts",
"format-check": "prettier --check **/*.ts",
"test": "jest"
"lint": "eslint src/**/*.ts",
"pack": "ncc build",
"test": "jest",
"all": "npm run build && npm run format && npm run lint && npm run pack && npm test"
},
"repository": {
"type": "git",
@@ -22,29 +25,25 @@
"author": "GitHub",
"license": "MIT",
"dependencies": {
"@actions/core": "file:toolkit/actions-core-0.0.0.tgz",
"@actions/exec": "file:toolkit/actions-exec-0.0.0.tgz",
"@actions/github": "file:toolkit/actions-github-0.0.0.tgz",
"@actions/io": "file:toolkit/actions-io-0.0.0.tgz",
"@actions/tool-cache": "file:toolkit/actions-tool-cache-0.0.0.tgz",
"@actions/core": "^1.2.3",
"@actions/github": "^2.1.1",
"@octokit/rest": "^16.43.1",
"semver": "^6.1.1"
},
"devDependencies": {
"@types/jest": "^24.0.13",
"@types/node": "^12.6.8",
"@types/semver": "^6.0.0",
"husky": "^2.3.0",
"jest": "^24.8.0",
"jest-circus": "^24.7.1",
"prettier": "^1.17.1",
"ts-jest": "^24.0.2",
"typescript": "^3.5.1"
},
"husky": {
"skipCI": true,
"hooks": {
"pre-commit": "npm run build && npm run format",
"post-commit": "npm prune --production && git add node_modules/* && git commit -m \"Husky commit correct node modules\""
}
"@types/jest": "^24.0.23",
"@types/node": "^12.7.12",
"@typescript-eslint/parser": "^2.8.0",
"@zeit/ncc": "^0.20.5",
"eslint": "^5.16.0",
"eslint-plugin-github": "^2.0.0",
"eslint-plugin-jest": "^22.21.0",
"jest": "^24.9.0",
"jest-circus": "^24.9.0",
"js-yaml": "^3.13.1",
"prettier": "^1.19.1",
"ts-jest": "^24.2.0",
"typescript": "^3.6.4"
}
}

View File

@@ -1,22 +1,25 @@
import * as core from '@actions/core';
import * as github from '@actions/github';
import * as Octokit from '@octokit/rest';
import {Octokit} from '@octokit/rest';
type Issue = Octokit.IssuesListForRepoResponseItem;
type IssueLabel = Octokit.IssuesListForRepoResponseItemLabelsItem;
type Args = {
interface Args {
repoToken: string;
staleIssueMessage: string;
stalePrMessage: string;
daysBeforeStale: number;
daysBeforeClose: number;
staleIssueLabel: string;
exemptIssueLabel: string;
stalePrLabel: string;
exemptPrLabel: string;
onlyLabels: string;
operationsPerRun: number;
};
}
async function run() {
async function run(): Promise<void> {
try {
const args = getAndValidateArgs();
@@ -38,8 +41,9 @@ async function processIssues(
owner: github.context.repo.owner,
repo: github.context.repo.repo,
state: 'open',
labels: args.onlyLabels,
per_page: 100,
page: page
page
});
operationsLeft -= 1;
@@ -48,20 +52,26 @@ async function processIssues(
return operationsLeft;
}
for (var issue of issues.data.values()) {
for (const issue of issues.data.values()) {
core.debug(`found issue: ${issue.title} last updated ${issue.updated_at}`);
let isPr = !!issue.pull_request;
const isPr = !!issue.pull_request;
let staleMessage = isPr ? args.stalePrMessage : args.staleIssueMessage;
const staleMessage = isPr ? args.stalePrMessage : args.staleIssueMessage;
if (!staleMessage) {
core.debug(`skipping ${isPr ? 'pr' : 'issue'} due to empty message`);
continue;
}
let staleLabel = isPr ? args.stalePrLabel : args.staleIssueLabel;
const staleLabel = isPr ? args.stalePrLabel : args.staleIssueLabel;
const exemptLabel = isPr ? args.exemptPrLabel : args.exemptIssueLabel;
if (isLabeledStale(issue, staleLabel)) {
if (wasLastUpdatedBefore(issue, args.daysBeforeClose)) {
if (exemptLabel && isLabeled(issue, exemptLabel)) {
continue;
} else if (isLabeled(issue, staleLabel)) {
if (
args.daysBeforeClose >= 0 &&
wasLastUpdatedBefore(issue, args.daysBeforeClose)
) {
operationsLeft -= await closeIssue(client, issue);
} else {
continue;
@@ -85,14 +95,14 @@ async function processIssues(
return await processIssues(client, args, operationsLeft, page + 1);
}
function isLabeledStale(issue: Issue, label: string): boolean {
function isLabeled(issue: Issue, label: string): boolean {
const labelComparer: (l: IssueLabel) => boolean = l =>
label.localeCompare(l.name, undefined, {sensitivity: 'accent'}) === 0;
return issue.labels.filter(labelComparer).length > 0;
}
function wasLastUpdatedBefore(issue: Issue, num_days: number): boolean {
const daysInMillis = 1000 * 60 * 60 * num_days;
const daysInMillis = 1000 * 60 * 60 * 24 * num_days;
const millisSinceLastUpdated =
new Date().getTime() - new Date(issue.updated_at).getTime();
return millisSinceLastUpdated >= daysInMillis;
@@ -151,13 +161,16 @@ function getAndValidateArgs(): Args {
core.getInput('days-before-close', {required: true})
),
staleIssueLabel: core.getInput('stale-issue-label', {required: true}),
exemptIssueLabel: core.getInput('exempt-issue-label'),
stalePrLabel: core.getInput('stale-pr-label', {required: true}),
exemptPrLabel: core.getInput('exempt-pr-label'),
onlyLabels: core.getInput('only-labels'),
operationsPerRun: parseInt(
core.getInput('operations-per-run', {required: true})
)
};
for (var numberInput of [
for (const numberInput of [
'days-before-stale',
'days-before-close',
'operations-per-run'

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@@ -1,63 +1,12 @@
{
"compilerOptions": {
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./lib", /* Redirect output structure to the directory. */
"rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
"noImplicitAny": false, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
},
"exclude": ["node_modules", "**/*.test.ts"]
}
}