Skip to content

Commit 6ec637d

Browse files
C0ZENC0ZEN
authored
feat(options): simplify config by removing skip stale message options (#457)
* feat(options): simplify config by removing skip stale message options Closes #405 Closes #455 BREAKING CHANGES: remove skip-stale-issue-message and skip-stale-pr-message options. If you used this option, replace it by an empty message for the options stale-issue-message and stale-pr-message * build(dist): update dist also lint some files * docs(readme): update the docs by removing the skip options
1 parent 16dfaa2 commit 6ec637d

12 files changed

+1844
-1880
lines changed

‎.github/ISSUE_TEMPLATE/stale_issue_report.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ jobs:
2020
runs-on: ...
2121
steps:
2222
- uses: actions/stale@...
23-
with:
24-
...
23+
with: ...
2524
```
2625
2726
## Further context

‎.github/pull_request_template.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<!-- List the change(s) you're making with this PR. -->
2+
23
## Changes
4+
35
- [x] ...
46

57
## Context

‎README.md

+2-20
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,6 @@ Every argument is optional.
3939
| [remove-pr-stale-when-updated](#remove-pr-stale-when-updated) | Remove stale label from PRs on updates/comments | |
4040
| [debug-only](#debug-only) | Dry-run | `false` |
4141
| [ascending](#ascending) | Order to get issues/PRs | `false` |
42-
| [skip-stale-issue-message](#skip-stale-issue-message) | Skip adding stale message on stale issues | `false` |
43-
| [skip-stale-pr-message](#skip-stale-pr-message) | Skip adding stale message on stale PRs | `false` |
4442
| [start-date](#start-date) | Skip stale action for issues/PRs created before it | |
4543
| [delete-branch](#delete-branch) | Delete branch after closing a stale PR | `false` |
4644
| [exempt-milestones](#exempt-milestones) | Milestones on issues/PRs exempted from stale | |
@@ -141,15 +139,15 @@ Default value: unset
141139

142140
The message that will be added as a comment to the issues when the stale workflow marks it automatically as stale with a label.
143141

144-
You can omit the comment by setting [skip-stale-issue-message](#skip-stale-issue-message) to `true`.
142+
You can skip the comment sending by omitting the option or by passing an empty string.
145143

146144
Default value: unset
147145

148146
#### stale-pr-message
149147

150148
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.
151149

152-
You can omit the comment by setting [skip-stale-pr-message](#skip-stale-pr-message) to `true`.
150+
You can skip the comment sending by omitting the option or by passing an empty string.
153151

154152
Default value: unset
155153

@@ -316,22 +314,6 @@ Based on the order, you could prefer to focus on the new content or on the old c
316314

317315
Default value: `false`
318316

319-
#### skip-stale-issue-message
320-
321-
If set to `true`, no comment will be added to the issues when they are automatically marked as stale.
322-
323-
If set to `false`, you can define the comment with the [stale-issue-message](#stale-issue-message) option.
324-
325-
Default value: `false`
326-
327-
#### skip-stale-pr-message
328-
329-
If set to `true`, no comment will be added to the pull requests when they are automatically marked as stale.
330-
331-
If set to `false`, you can define the comment with the [stale-pr-message](#stale-pr-message) option.
332-
333-
Default value: `false`
334-
335317
#### start-date
336318

337319
The start date is used to ignore the issues and pull requests created before the start date.

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

-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ export const DefaultProcessorOptions: IIssuesProcessorOptions = Object.freeze({
3030
removeIssueStaleWhenUpdated: undefined,
3131
removePrStaleWhenUpdated: undefined,
3232
ascending: false,
33-
skipStaleIssueMessage: false,
34-
skipStalePrMessage: false,
3533
deleteBranch: false,
3634
startDate: '',
3735
exemptMilestones: '',

‎__tests__/main.spec.ts

+39-17
Original file line numberDiff line numberDiff line change
@@ -1422,11 +1422,11 @@ test('stale issues should not be closed until after the closed number of days (l
14221422
expect(processor.staleIssues).toHaveLength(1);
14231423
});
14241424

1425-
test('skips stale message on issues when skip-stale-issue-message is set', async () => {
1425+
test('skips stale message on issues when stale-issue-message is empty', async () => {
14261426
const opts = {...DefaultProcessorOptions};
14271427
opts.daysBeforeStale = 5; // stale after 5 days
14281428
opts.daysBeforeClose = 20; // closes after 25 days
1429-
opts.skipStaleIssueMessage = true;
1429+
opts.staleIssueMessage = '';
14301430
const lastUpdate = new Date();
14311431
lastUpdate.setDate(lastUpdate.getDate() - 10);
14321432
const TestIssueList: Issue[] = [
@@ -1467,11 +1467,11 @@ test('skips stale message on issues when skip-stale-issue-message is set', async
14671467
);
14681468
});
14691469

1470-
test('skips stale message on prs when skip-stale-pr-message is set', async () => {
1470+
test('send stale message on issues when stale-issue-message is not empty', async () => {
14711471
const opts = {...DefaultProcessorOptions};
14721472
opts.daysBeforeStale = 5; // stale after 5 days
14731473
opts.daysBeforeClose = 20; // closes after 25 days
1474-
opts.skipStalePrMessage = true;
1474+
opts.staleIssueMessage = 'dummy issue message';
14751475
const lastUpdate = new Date();
14761476
lastUpdate.setDate(lastUpdate.getDate() - 10);
14771477
const TestIssueList: Issue[] = [
@@ -1481,7 +1481,7 @@ test('skips stale message on prs when skip-stale-pr-message is set', async () =>
14811481
'An issue that should be marked stale but not closed',
14821482
lastUpdate.toString(),
14831483
lastUpdate.toString(),
1484-
true
1484+
false
14851485
)
14861486
];
14871487
const processor = new IssuesProcessorMock(
@@ -1505,19 +1505,18 @@ test('skips stale message on prs when skip-stale-pr-message is set', async () =>
15051505
// comment should not be created
15061506
expect(markSpy).toHaveBeenCalledWith(
15071507
TestIssueList[0],
1508-
opts.stalePrMessage,
1509-
opts.stalePrLabel,
1508+
opts.staleIssueMessage,
1509+
opts.staleIssueLabel,
15101510
// this option is skipMessage
1511-
true
1511+
false
15121512
);
15131513
});
15141514

1515-
test('not providing state takes precedence over skipStaleIssueMessage', async () => {
1515+
test('skips stale message on prs when stale-pr-message is empty', async () => {
15161516
const opts = {...DefaultProcessorOptions};
15171517
opts.daysBeforeStale = 5; // stale after 5 days
15181518
opts.daysBeforeClose = 20; // closes after 25 days
1519-
opts.skipStalePrMessage = true;
1520-
opts.staleIssueMessage = '';
1519+
opts.stalePrMessage = '';
15211520
const lastUpdate = new Date();
15221521
lastUpdate.setDate(lastUpdate.getDate() - 10);
15231522
const TestIssueList: Issue[] = [
@@ -1527,7 +1526,7 @@ test('not providing state takes precedence over skipStaleIssueMessage', async ()
15271526
'An issue that should be marked stale but not closed',
15281527
lastUpdate.toString(),
15291528
lastUpdate.toString(),
1530-
false
1529+
true
15311530
)
15321531
];
15331532
const processor = new IssuesProcessorMock(
@@ -1538,20 +1537,31 @@ test('not providing state takes precedence over skipStaleIssueMessage', async ()
15381537
async () => new Date().toDateString()
15391538
);
15401539

1540+
// for sake of testing, mocking private function
1541+
const markSpy = jest.spyOn(processor as any, '_markStale');
1542+
15411543
await processor.processIssues(1);
15421544

15431545
// issue should be staled
15441546
expect(processor.closedIssues).toHaveLength(0);
15451547
expect(processor.removedLabelIssues).toHaveLength(0);
1546-
expect(processor.staleIssues).toHaveLength(0);
1548+
expect(processor.staleIssues).toHaveLength(1);
1549+
1550+
// comment should not be created
1551+
expect(markSpy).toHaveBeenCalledWith(
1552+
TestIssueList[0],
1553+
opts.stalePrMessage,
1554+
opts.stalePrLabel,
1555+
// this option is skipMessage
1556+
true
1557+
);
15471558
});
15481559

1549-
test('not providing stalePrMessage takes precedence over skipStalePrMessage', async () => {
1560+
test('send stale message on prs when stale-pr-message is not empty', async () => {
15501561
const opts = {...DefaultProcessorOptions};
15511562
opts.daysBeforeStale = 5; // stale after 5 days
15521563
opts.daysBeforeClose = 20; // closes after 25 days
1553-
opts.skipStalePrMessage = true;
1554-
opts.stalePrMessage = '';
1564+
opts.stalePrMessage = 'dummy pr message';
15551565
const lastUpdate = new Date();
15561566
lastUpdate.setDate(lastUpdate.getDate() - 10);
15571567
const TestIssueList: Issue[] = [
@@ -1572,12 +1582,24 @@ test('not providing stalePrMessage takes precedence over skipStalePrMessage', as
15721582
async () => new Date().toDateString()
15731583
);
15741584

1585+
// for sake of testing, mocking private function
1586+
const markSpy = jest.spyOn(processor as any, '_markStale');
1587+
15751588
await processor.processIssues(1);
15761589

15771590
// issue should be staled
15781591
expect(processor.closedIssues).toHaveLength(0);
15791592
expect(processor.removedLabelIssues).toHaveLength(0);
1580-
expect(processor.staleIssues).toHaveLength(0);
1593+
expect(processor.staleIssues).toHaveLength(1);
1594+
1595+
// comment should not be created
1596+
expect(markSpy).toHaveBeenCalledWith(
1597+
TestIssueList[0],
1598+
opts.stalePrMessage,
1599+
opts.stalePrLabel,
1600+
// this option is skipMessage
1601+
false
1602+
);
15811603
});
15821604

15831605
test('git branch is deleted when option is enabled', async () => {

‎action.yml

-8
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,6 @@ inputs:
132132
description: 'The order to get issues or pull requests. Defaults to false, which is descending.'
133133
default: 'false'
134134
required: false
135-
skip-stale-pr-message:
136-
description: 'Skip adding stale message when marking a pull request as stale.'
137-
default: 'false'
138-
required: false
139-
skip-stale-issue-message:
140-
description: 'Skip adding stale message when marking an issue as stale.'
141-
default: 'false'
142-
required: false
143135
delete-branch:
144136
description: 'Delete the git branch after closing a stale pull request.'
145137
default: 'false'

0 commit comments

Comments
 (0)