adding targetURL when using status action (#118)

gagoar · cyamonide · web-flow · commit bb169fea6403 · 2020-09-07T22:19:49.000-07:00
* adding targetURL when using `status` action

* spelling

* adding validation link to the wiki

* allowing targetURL to be passed in the rules

* Update README.md

Co-authored-by: Simon Liu &lt;cyamonide@gmail.com&gt;

* adding link for Description validation

* proper link

* Update herald_rules/validate_description_is_present.json

Co-authored-by: Simon Liu &lt;cyamonide@gmail.com&gt;

* Update herald_rules/validate_issue_is_present.json

Co-authored-by: Simon Liu &lt;cyamonide@gmail.com&gt;
diff --git a/README.md b/README.md
@@ -85,6 +85,7 @@ Every rule can be written in JSON with the following key-value pairs:
 | `customMessage`   |        `string`        |    No    | Message to be commented on the pull request when the rule is applied (requires `action === comment`)                                                                                                                                                     |
 | `users`           |       `string[]`       |    No    | GitHub user handles (or emails) on which the rule will take action. It will not be used when `action` is set to `comment` and `customMessage` field is present                                                                                           |
 | `teams`           |       `string[]`       |    No    | GitHub teams on which the rule will take action. It will not be used when `action` is set to `comment` and `customMessage` field is present                                                                                                              |
+| `targetURL`       |        `string`        |    No    | When `action` set to `status`, link to which the [Details](https://github.blog/2012-09-04-commit-status-api/) link will point                                                                                                                          |
 | `labels`          |       `string[]`       |    No    | Github labels which the rule will add. Only valid when `action` field is set to `label`                                                                                                                                                                  |
 | `errorLevel`      |        `string`        |    No    | Currently, supported error levels are `none`, `error`, by default is set to `none`, you can read more [here](#error-levels)                                                                                                                              |
 
diff --git a/__tests__/statuses.spec.ts b/__tests__/statuses.spec.ts
@@ -38,6 +38,13 @@ describe('handleReviewers', () => {
     glob: '*.js',
   };
 
+  const rule3 = {
+    ...rule,
+    path: `${env.GITHUB_WORKSPACE}/rules/rule2.json`,
+    targetURL: 'http://some/link',
+    name: 'it should have js files in the PR',
+    glob: '*.js',
+  };
   beforeEach(() => {
     nock.cleanAll();
   });
@@ -57,6 +64,13 @@ describe('handleReviewers', () => {
         cb(null, { ...createStatusRequest, target_url, description, state, context });
       });
 
+    github
+      .post(`/repos/${owner}/${repo}/statuses/${sha}`)
+      .reply(201, (_uri, body: { target_url: string; description: string; state: string; context: string }, cb) => {
+        const { target_url, description, state, context } = body;
+        cb(null, { ...createStatusRequest, target_url, description, state, context });
+      });
+
     const files = [
       {
         filename: 'rules/rule.json',
@@ -70,7 +84,7 @@ describe('handleReviewers', () => {
       repo,
       prNumber,
       matchingRules: [{ ...rule, matched: true }],
-      rules: [rule, rule2],
+      rules: [rule, rule2, rule3],
       sha,
       base: '6dcb09b5b57875f334f61aebed695e2e4193d111',
       files,
@@ -156,6 +170,45 @@ describe('handleReviewers', () => {
           "status": 201,
           "url": "https://api.github.com/repos/gagoar/example_repo/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
         },
+        Object {
+          "data": Object {
+            "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+            "context": "Herald/it should have js files in the PR",
+            "created_at": "2012-07-20T01:19:13Z",
+            "creator": Object {
+              "avatar_url": "https://github.com/images/error/gagoar_happy.gif",
+              "events_url": "https://api.github.com/users/gagoar/events{/privacy}",
+              "followers_url": "https://api.github.com/users/gagoar/followers",
+              "following_url": "https://api.github.com/users/gagoar/following{/other_user}",
+              "gists_url": "https://api.github.com/users/gagoar/gists{/gist_id}",
+              "gravatar_id": "",
+              "html_url": "https://github.com/gagoar",
+              "id": 1,
+              "login": "gagoar",
+              "node_id": "MDQ6VXNlcjE=",
+              "organizations_url": "https://api.github.com/users/gagoar/orgs",
+              "received_events_url": "https://api.github.com/users/gagoar/received_events",
+              "repos_url": "https://api.github.com/users/gagoar/repos",
+              "site_admin": false,
+              "starred_url": "https://api.github.com/users/gagoar/starred{/owner}{/repo}",
+              "subscriptions_url": "https://api.github.com/users/gagoar/subscriptions",
+              "type": "User",
+              "url": "https://api.github.com/users/gagoar",
+            },
+            "description": "You can see the rule by clicking on Details",
+            "id": 1,
+            "node_id": "MDY6U3RhdHVzMQ==",
+            "state": "failure",
+            "target_url": "http://some/link",
+            "updated_at": "2012-07-20T01:19:13Z",
+            "url": "https://api.github.com/repos/gagoar/example_repo/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+          },
+          "headers": Object {
+            "content-type": "application/json",
+          },
+          "status": 201,
+          "url": "https://api.github.com/repos/gagoar/example_repo/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        },
       ]
     `);
     expect(github.isDone()).toBe(true);
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/src/rules.d.ts b/dist/src/rules.d.ts
@@ -23,6 +23,7 @@ export interface Rule {
     customMessage?: string;
     labels?: string[];
     description?: string;
+    targetURL?: string;
     errorLevel?: keyof typeof ErrorLevels;
 }
 export declare const loadRules: (rulesLocation: string) => Rule[];
diff --git a/herald_rules/validate_description_is_present.json b/herald_rules/validate_description_is_present.json
@@ -1,5 +1,6 @@
 {
   "name": "The template has a Description",
+  "targetURL": "https://github.com/gagoar/use-herald-action/wiki/PR-Validations#validate-description-title-is-present",
   "action": "status",
   "eventJsonPath": ["$[?(@.body.match(/## Description/i))].body"]
 }
diff --git a/herald_rules/validate_issue_is_present.json b/herald_rules/validate_issue_is_present.json
@@ -1,6 +1,7 @@
 {
   "name": "The template has an issue attached",
-  "description": "Check if an issue present on PR",
+  "description": "Check if an issue is present on PR",
+  "targetURL": "https://github.com/gagoar/use-herald-action/wiki/PR-Validations#validate-if-the-issue-is-present-in-the-prs-description",
   "action": "status",
   "eventJsonPath": ["$[?(@.body.match(/Issue Reference.+#[0-9]+/i))].body"]
 }
diff --git a/src/rules.ts b/src/rules.ts
@@ -31,10 +31,9 @@ enum RuleExtras {
   customMessage = 'customMessage',
   name = 'name',
   errorLevel = 'errorLevel',
-
   labels = 'labels',
-
   description = 'description',
+  targetURL = 'targetURL',
 }
 enum RuleMatchers {
   includesInPatch = 'includesInPatch',
@@ -70,11 +69,9 @@ export interface Rule {
   includesInPatch?: string[];
   eventJsonPath?: string[];
   customMessage?: string;
-
   labels?: string[];
-
   description?: string;
-
+  targetURL?: string;
   errorLevel?: keyof typeof ErrorLevels;
 }
 
diff --git a/src/statuses.ts b/src/statuses.ts
@@ -33,9 +33,9 @@ export const handleStatus: ActionMapInput = async (
     owner,
     repo,
     sha,
-    description: rule.description ? rule.description : STATUS_DESCRIPTION_COPY,
     context: `Herald/${rule.name}`,
-    target_url: getBlobURL(rule.path, files, baseBlobPath, base),
+    description: rule.description ? rule.description : STATUS_DESCRIPTION_COPY,
+    target_url: rule.targetURL ? rule.targetURL : getBlobURL(rule.path, files, baseBlobPath, base),
     state: matchingRules.find((matchingRule) => matchingRule.path === rule.path)
       ? CommitStatus.SUCCESS
       : CommitStatus.FAILURE,

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ export interface Rule {`
`23`	`23`	`customMessage?: string;`
`24`	`24`	`labels?: string[];`
`25`	`25`	`description?: string;`
	`26`	`+ targetURL?: string;`
`26`	`27`	`errorLevel?: keyof typeof ErrorLevels;`
`27`	`28`	`}`
`28`	`29`	`export declare const loadRules: (rulesLocation: string) => Rule[];`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "The template has a Description",`
	`3`	`+ "targetURL": "https://github.com/gagoar/use-herald-action/wiki/PR-Validations#validate-description-title-is-present",`
`3`	`4`	`"action": "status",`
`4`	`5`	`"eventJsonPath": ["$[?(@.body.match(/## Description/i))].body"]`
`5`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "The template has an issue attached",`
`3`		`- "description": "Check if an issue present on PR",`
	`3`	`+ "description": "Check if an issue is present on PR",`
	`4`	`+ "targetURL": "https://github.com/gagoar/use-herald-action/wiki/PR-Validations#validate-if-the-issue-is-present-in-the-prs-description",`
`4`	`5`	`"action": "status",`
`5`	`6`	`"eventJsonPath": ["$[?(@.body.match(/Issue Reference.+#[0-9]+/i))].body"]`
`6`	`7`	`}`