fix(dry-run): forbid mutations in dry-run (#500)

Bring back the dry-run by default for the tests - bad idea to disable it sorry
Fix bad documentation array format
Fixes #499
This commit is contained in:
Geoffrey Testelin 2021-06-10 16:14:45 +02:00 committed by GitHub
parent b1da9e1fb1
commit f1017f33dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 66 additions and 55 deletions

View File

@ -43,8 +43,8 @@ Every argument is optional.
| [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/comments | `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 | |

View File

@ -25,7 +25,7 @@ export const DefaultProcessorOptions: IIssuesProcessorOptions = Object.freeze({
anyOfIssueLabels: '', anyOfIssueLabels: '',
anyOfPrLabels: '', anyOfPrLabels: '',
operationsPerRun: 100, operationsPerRun: 100,
debugOnly: false, debugOnly: true,
removeStaleWhenUpdated: false, removeStaleWhenUpdated: false,
removeIssueStaleWhenUpdated: undefined, removeIssueStaleWhenUpdated: undefined,
removePrStaleWhenUpdated: undefined, removePrStaleWhenUpdated: undefined,

56
dist/index.js vendored
View File

@ -661,12 +661,14 @@ class IssuesProcessor {
this._consumeIssueOperation(issue); this._consumeIssueOperation(issue);
(_b = this._statistics) === null || _b === void 0 ? void 0 : _b.incrementAddedItemsLabel(issue); (_b = this._statistics) === null || _b === void 0 ? void 0 : _b.incrementAddedItemsLabel(issue);
(_c = this._statistics) === null || _c === void 0 ? void 0 : _c.incrementStaleItemsCount(issue); (_c = this._statistics) === null || _c === void 0 ? void 0 : _c.incrementStaleItemsCount(issue);
yield this.client.issues.addLabels({ if (!this.options.debugOnly) {
owner: github_1.context.repo.owner, yield this.client.issues.addLabels({
repo: github_1.context.repo.repo, owner: github_1.context.repo.owner,
issue_number: issue.number, repo: github_1.context.repo.repo,
labels: [staleLabel] issue_number: issue.number,
}); labels: [staleLabel]
});
}
} }
catch (error) { catch (error) {
issueLogger.error(`Error when adding a label: ${error.message}`); issueLogger.error(`Error when adding a label: ${error.message}`);
@ -701,12 +703,14 @@ class IssuesProcessor {
try { try {
this._consumeIssueOperation(issue); this._consumeIssueOperation(issue);
(_b = this._statistics) === null || _b === void 0 ? void 0 : _b.incrementAddedItemsLabel(issue); (_b = this._statistics) === null || _b === void 0 ? void 0 : _b.incrementAddedItemsLabel(issue);
yield this.client.issues.addLabels({ if (!this.options.debugOnly) {
owner: github_1.context.repo.owner, yield this.client.issues.addLabels({
repo: github_1.context.repo.repo, owner: github_1.context.repo.owner,
issue_number: issue.number, repo: github_1.context.repo.repo,
labels: [closeLabel] issue_number: issue.number,
}); labels: [closeLabel]
});
}
} }
catch (error) { catch (error) {
issueLogger.error(`Error when adding a label: ${error.message}`); issueLogger.error(`Error when adding a label: ${error.message}`);
@ -715,12 +719,14 @@ class IssuesProcessor {
try { try {
this._consumeIssueOperation(issue); this._consumeIssueOperation(issue);
(_c = this._statistics) === null || _c === void 0 ? void 0 : _c.incrementClosedItemsCount(issue); (_c = this._statistics) === null || _c === void 0 ? void 0 : _c.incrementClosedItemsCount(issue);
yield this.client.issues.update({ if (!this.options.debugOnly) {
owner: github_1.context.repo.owner, yield this.client.issues.update({
repo: github_1.context.repo.repo, owner: github_1.context.repo.owner,
issue_number: issue.number, repo: github_1.context.repo.repo,
state: 'closed' issue_number: issue.number,
}); state: 'closed'
});
}
} }
catch (error) { catch (error) {
issueLogger.error(`Error when updating this $$type: ${error.message}`); issueLogger.error(`Error when updating this $$type: ${error.message}`);
@ -734,14 +740,12 @@ class IssuesProcessor {
try { try {
this._consumeIssueOperation(issue); this._consumeIssueOperation(issue);
(_a = this._statistics) === null || _a === void 0 ? void 0 : _a.incrementFetchedPullRequestsCount(); (_a = this._statistics) === null || _a === void 0 ? void 0 : _a.incrementFetchedPullRequestsCount();
if (!this.options.debugOnly) { const pullRequest = yield this.client.pulls.get({
const pullRequest = yield this.client.pulls.get({ owner: github_1.context.repo.owner,
owner: github_1.context.repo.owner, repo: github_1.context.repo.repo,
repo: github_1.context.repo.repo, pull_number: issue.number
pull_number: issue.number });
}); return pullRequest.data;
return pullRequest.data;
}
} }
catch (error) { catch (error) {
issueLogger.error(`Error when getting this $$type: ${error.message}`); issueLogger.error(`Error when getting this $$type: ${error.message}`);

View File

@ -740,12 +740,15 @@ export class IssuesProcessor {
this._consumeIssueOperation(issue); this._consumeIssueOperation(issue);
this._statistics?.incrementAddedItemsLabel(issue); this._statistics?.incrementAddedItemsLabel(issue);
this._statistics?.incrementStaleItemsCount(issue); this._statistics?.incrementStaleItemsCount(issue);
await this.client.issues.addLabels({
owner: context.repo.owner, if (!this.options.debugOnly) {
repo: context.repo.repo, await this.client.issues.addLabels({
issue_number: issue.number, owner: context.repo.owner,
labels: [staleLabel] repo: context.repo.repo,
}); issue_number: issue.number,
labels: [staleLabel]
});
}
} catch (error) { } catch (error) {
issueLogger.error(`Error when adding a label: ${error.message}`); issueLogger.error(`Error when adding a label: ${error.message}`);
} }
@ -784,12 +787,15 @@ export class IssuesProcessor {
try { try {
this._consumeIssueOperation(issue); this._consumeIssueOperation(issue);
this._statistics?.incrementAddedItemsLabel(issue); this._statistics?.incrementAddedItemsLabel(issue);
await this.client.issues.addLabels({
owner: context.repo.owner, if (!this.options.debugOnly) {
repo: context.repo.repo, await this.client.issues.addLabels({
issue_number: issue.number, owner: context.repo.owner,
labels: [closeLabel] repo: context.repo.repo,
}); issue_number: issue.number,
labels: [closeLabel]
});
}
} catch (error) { } catch (error) {
issueLogger.error(`Error when adding a label: ${error.message}`); issueLogger.error(`Error when adding a label: ${error.message}`);
} }
@ -798,12 +804,15 @@ export class IssuesProcessor {
try { try {
this._consumeIssueOperation(issue); this._consumeIssueOperation(issue);
this._statistics?.incrementClosedItemsCount(issue); this._statistics?.incrementClosedItemsCount(issue);
await this.client.issues.update({
owner: context.repo.owner, if (!this.options.debugOnly) {
repo: context.repo.repo, await this.client.issues.update({
issue_number: issue.number, owner: context.repo.owner,
state: 'closed' repo: context.repo.repo,
}); issue_number: issue.number,
state: 'closed'
});
}
} catch (error) { } catch (error) {
issueLogger.error(`Error when updating this $$type: ${error.message}`); issueLogger.error(`Error when updating this $$type: ${error.message}`);
} }
@ -818,15 +827,13 @@ export class IssuesProcessor {
this._consumeIssueOperation(issue); this._consumeIssueOperation(issue);
this._statistics?.incrementFetchedPullRequestsCount(); this._statistics?.incrementFetchedPullRequestsCount();
if (!this.options.debugOnly) { const pullRequest = await this.client.pulls.get({
const pullRequest = await this.client.pulls.get({ owner: context.repo.owner,
owner: context.repo.owner, repo: context.repo.repo,
repo: context.repo.repo, pull_number: issue.number
pull_number: issue.number });
});
return pullRequest.data; return pullRequest.data;
}
} catch (error) { } catch (error) {
issueLogger.error(`Error when getting this $$type: ${error.message}`); issueLogger.error(`Error when getting this $$type: ${error.message}`);
} }