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

__tests__/constants/default-processor-options.ts

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

dist/index.js

@@ -661,6 +661,7 @@ class IssuesProcessor {
                 this._consumeIssueOperation(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);
+                if (!this.options.debugOnly) {
                     yield this.client.issues.addLabels({
                         owner: github_1.context.repo.owner,
                         repo: github_1.context.repo.repo,
@@ -668,6 +669,7 @@ class IssuesProcessor {
                         labels: [staleLabel]
                     });
                 }
+            }
             catch (error) {
                 issueLogger.error(`Error when adding a label: ${error.message}`);
             }
@@ -701,6 +703,7 @@ class IssuesProcessor {
                 try {
                     this._consumeIssueOperation(issue);
                     (_b = this._statistics) === null || _b === void 0 ? void 0 : _b.incrementAddedItemsLabel(issue);
+                    if (!this.options.debugOnly) {
                         yield this.client.issues.addLabels({
                             owner: github_1.context.repo.owner,
                             repo: github_1.context.repo.repo,
@@ -708,6 +711,7 @@ class IssuesProcessor {
                             labels: [closeLabel]
                         });
                     }
+                }
                 catch (error) {
                     issueLogger.error(`Error when adding a label: ${error.message}`);
                 }
@@ -715,6 +719,7 @@ class IssuesProcessor {
             try {
                 this._consumeIssueOperation(issue);
                 (_c = this._statistics) === null || _c === void 0 ? void 0 : _c.incrementClosedItemsCount(issue);
+                if (!this.options.debugOnly) {
                     yield this.client.issues.update({
                         owner: github_1.context.repo.owner,
                         repo: github_1.context.repo.repo,
@@ -722,6 +727,7 @@ class IssuesProcessor {
                         state: 'closed'
                     });
                 }
+            }
             catch (error) {
                 issueLogger.error(`Error when updating this $$type: ${error.message}`);
             }
@@ -734,7 +740,6 @@ class IssuesProcessor {
             try {
                 this._consumeIssueOperation(issue);
                 (_a = this._statistics) === null || _a === void 0 ? void 0 : _a.incrementFetchedPullRequestsCount();
-                if (!this.options.debugOnly) {
                 const pullRequest = yield this.client.pulls.get({
                     owner: github_1.context.repo.owner,
                     repo: github_1.context.repo.repo,
@@ -742,7 +747,6 @@ class IssuesProcessor {
                 });
                 return pullRequest.data;
             }
-            }
             catch (error) {
                 issueLogger.error(`Error when getting this $$type: ${error.message}`);
             }

src/classes/issues-processor.ts

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