Skip to content

Commit 9912fa7

Browse files
C0ZENC0ZEN
authored
feat(draft-pr): add new option to not process PRs which are in draft (#539)
* chore(assignees): add logs * feat(draft-pr): add new option to not process PRs which are in draft * refactor(draft-pr): create a dedicated class to handle the logic * chore(index): update index file
1 parent 303465a commit 9912fa7

13 files changed

+367
-72
lines changed

‎README.md

+9
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ Every argument is optional.
7575
| [exempt-all-assignees](#exempt-all-assignees) | Exempt all issues/PRs with assignees from stale | `false` |
7676
| [exempt-all-issue-assignees](#exempt-all-issue-assignees) | Override [exempt-all-assignees](#exempt-all-assignees) for issues only | |
7777
| [exempt-all-pr-assignees](#exempt-all-pr-assignees) | Override [exempt-all-assignees](#exempt-all-assignees) for PRs only | |
78+
| [exempt-draft-pr](#exempt-draft-pr) | Skip the stale action for draft PRs | `false` |
7879
| [enable-statistics](#enable-statistics) | Display statistics in the logs | `true` |
7980
| [ignore-updates](#ignore-updates) | Any update (update/comment) can reset the stale idle time on the issues/PRs | `false` |
8081
| [ignore-issue-updates](#ignore-issue-updates) | Override [ignore-updates](#ignore-updates) for issues only | |
@@ -472,6 +473,14 @@ Override [exempt-all-assignees](#exempt-all-assignees) but only to exempt the pu
472473

473474
Default value: unset
474475

476+
#### exempt-draft-pr
477+
478+
If set to `true`, the pull requests currently in draft will not be marked as stale automatically.
479+
⚠️ 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.
480+
481+
Default value: `false`
482+
Required Permission: `pull-requests: read`
483+
475484
#### enable-statistics
476485

477486
Collects and display statistics at the end of the stale workflow logs to get a summary of what happened during the run.

‎__tests__/classes/issues-processor-mock.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import {Issue} from '../../src/classes/issue';
22
import {IssuesProcessor} from '../../src/classes/issues-processor';
33
import {IComment} from '../../src/interfaces/comment';
44
import {IIssuesProcessorOptions} from '../../src/interfaces/issues-processor-options';
5+
import {IPullRequest} from '../../src/interfaces/pull-request';
56

67
export class IssuesProcessorMock extends IssuesProcessor {
78
constructor(
@@ -14,7 +15,8 @@ export class IssuesProcessorMock extends IssuesProcessor {
1415
getLabelCreationDate?: (
1516
issue: Issue,
1617
label: string
17-
) => Promise<string | undefined>
18+
) => Promise<string | undefined>,
19+
getPullRequest?: (issue: Issue) => Promise<IPullRequest | undefined | void>
1820
) {
1921
super(options);
2022

@@ -29,5 +31,9 @@ export class IssuesProcessorMock extends IssuesProcessor {
2931
if (getLabelCreationDate) {
3032
this.getLabelCreationDate = getLabelCreationDate;
3133
}
34+
35+
if (getPullRequest) {
36+
this.getPullRequest = getPullRequest;
37+
}
3238
}
3339
}

‎__tests__/constants/default-processor-options.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,6 @@ export const DefaultProcessorOptions: IIssuesProcessorOptions = Object.freeze({
4949
labelsToAddWhenUnstale: '',
5050
ignoreUpdates: false,
5151
ignoreIssueUpdates: undefined,
52-
ignorePrUpdates: undefined
52+
ignorePrUpdates: undefined,
53+
exemptDraftPr: false
5354
});

‎__tests__/exempt-draft-pr.spec.ts

+139
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
import {Issue} from '../src/classes/issue';
2+
import {IIssue} from '../src/interfaces/issue';
3+
import {IIssuesProcessorOptions} from '../src/interfaces/issues-processor-options';
4+
import {IPullRequest} from '../src/interfaces/pull-request';
5+
import {IssuesProcessorMock} from './classes/issues-processor-mock';
6+
import {DefaultProcessorOptions} from './constants/default-processor-options';
7+
import {generateIssue} from './functions/generate-issue';
8+
9+
let issuesProcessorBuilder: IssuesProcessorBuilder;
10+
let issuesProcessor: IssuesProcessorMock;
11+
12+
describe('exempt-draft-pr option', (): void => {
13+
beforeEach((): void => {
14+
issuesProcessorBuilder = new IssuesProcessorBuilder();
15+
});
16+
17+
describe('when the option "exempt-draft-pr" is disabled', (): void => {
18+
beforeEach((): void => {
19+
issuesProcessorBuilder.processDraftPr();
20+
});
21+
22+
test('should stale the pull request', async (): Promise<void> => {
23+
expect.assertions(1);
24+
issuesProcessor = issuesProcessorBuilder
25+
.toStalePrs([
26+
{
27+
number: 10
28+
}
29+
])
30+
.build();
31+
32+
await issuesProcessor.processIssues();
33+
34+
expect(issuesProcessor.staleIssues).toHaveLength(1);
35+
});
36+
});
37+
38+
describe('when the option "exempt-draft-pr" is enabled', (): void => {
39+
beforeEach((): void => {
40+
issuesProcessorBuilder.exemptDraftPr();
41+
});
42+
43+
test('should not stale the pull request', async (): Promise<void> => {
44+
expect.assertions(1);
45+
issuesProcessor = issuesProcessorBuilder
46+
.toStalePrs([
47+
{
48+
number: 20
49+
}
50+
])
51+
.build();
52+
53+
await issuesProcessor.processIssues();
54+
55+
expect(issuesProcessor.staleIssues).toHaveLength(0);
56+
});
57+
});
58+
});
59+
60+
class IssuesProcessorBuilder {
61+
private _options: IIssuesProcessorOptions = {
62+
...DefaultProcessorOptions
63+
};
64+
private _issues: Issue[] = [];
65+
66+
processDraftPr(): IssuesProcessorBuilder {
67+
this._options.exemptDraftPr = false;
68+
69+
return this;
70+
}
71+
72+
exemptDraftPr(): IssuesProcessorBuilder {
73+
this._options.exemptDraftPr = true;
74+
75+
return this;
76+
}
77+
78+
issuesOrPrs(issues: Partial<IIssue>[]): IssuesProcessorBuilder {
79+
this._issues = issues.map(
80+
(issue: Readonly<Partial<IIssue>>, index: Readonly<number>): Issue =>
81+
generateIssue(
82+
this._options,
83+
issue.number ?? index,
84+
issue.title ?? 'dummy-title',
85+
issue.updated_at ?? new Date().toDateString(),
86+
issue.created_at ?? new Date().toDateString(),
87+
!!issue.pull_request,
88+
issue.labels ? issue.labels.map(label => label.name) : []
89+
)
90+
);
91+
92+
return this;
93+
}
94+
95+
prs(issues: Partial<IIssue>[]): IssuesProcessorBuilder {
96+
this.issuesOrPrs(
97+
issues.map((issue: Readonly<Partial<IIssue>>): Partial<IIssue> => {
98+
return {
99+
...issue,
100+
pull_request: {key: 'value'}
101+
};
102+
})
103+
);
104+
105+
return this;
106+
}
107+
108+
toStalePrs(issues: Partial<IIssue>[]): IssuesProcessorBuilder {
109+
this.prs(
110+
issues.map((issue: Readonly<Partial<IIssue>>): Partial<IIssue> => {
111+
return {
112+
...issue,
113+
updated_at: '2020-01-01T17:00:00Z',
114+
created_at: '2020-01-01T17:00:00Z'
115+
};
116+
})
117+
);
118+
119+
return this;
120+
}
121+
122+
build(): IssuesProcessorMock {
123+
return new IssuesProcessorMock(
124+
this._options,
125+
async p => (p === 1 ? this._issues : []),
126+
async () => [],
127+
async () => new Date().toDateString(),
128+
async (): Promise<IPullRequest> => {
129+
return Promise.resolve({
130+
number: 0,
131+
draft: true,
132+
head: {
133+
ref: 'ref'
134+
}
135+
});
136+
}
137+
);
138+
}
139+
}

‎action.yml

+4
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,10 @@ inputs:
164164
description: 'Exempt all pull requests with assignees from being marked as stale. Override "exempt-all-assignees" option regarding only the pull requests.'
165165
default: ''
166166
required: false
167+
exempt-draft-pr:
168+
description: 'Exempt draft pull requests from being marked as stale. Default to false.'
169+
default: 'false'
170+
required: false
167171
enable-statistics:
168172
description: 'Display some statistics at the end regarding the stale workflow (only when the logs are enabled).'
169173
default: 'true'

0 commit comments

Comments
 (0)