PR About Info (#11)

* add footer to PR message with URL
* Utility function to strip URLs from text
* add URL to header

__tests__/utils.test.ts

@@ -3,6 +3,7 @@
  */
 
 import {
+  stripURLs,
   assertNonNull,
   getUrlToFile,
   getUrlToChanges,
@@ -143,4 +144,11 @@ describe('utils.ts context dependent', () => {
     const duplicatesFiltered = duplicates.filter(uniqueFilter)
     expect(duplicatesFiltered).toEqual(noDuplicates)
   })
+
+  it('stripURLs(): Test stripping', () => {
+    const textWithoutURL = 'some text'
+    const textWithURL = 'some [text](leURL)'
+    const textStripped = stripURLs(textWithURL)
+    expect(textWithoutURL).toEqual(textStripped)
+  })
 })

src/main.ts

@@ -7,9 +7,16 @@ import {
   findFileByName,
   getUrlToChanges,
   getUrlToFile,
-  uniqueFilter
+  uniqueFilter,
+  stripURLs
 } from './utils'
 
+/**
+ * The URL to the project.
+ * Mainly used in the PR messages.
+ */
+const projectURL = 'https://github.com/AutoPas/DocTagChecker'
+
 /**
  * Checks if file extensions start with a '.' and then only consist of letters and numbers.
  * @param extension The extensions to check.
@@ -173,6 +180,10 @@ function checkDocumentation(
 /**
  * Remove last comment made by this action to avoid spam.
  * If no previous comment can be found do nothing.
+ *
+ * The header is used as a identification tag to find the correct message.
+ * This comparison is done ignoring any embedded URLs.
+ *
  * @param ghToken GitHub Token
  * @param header Header to identify the last bot message.
  * @returns {Promise<void>} Resolves when the function is complete.
@@ -195,7 +206,9 @@ async function deleteLastComment(
     for (let i = commentsResponse.data.length - 1; i >= 0; --i) {
       if (
         assertNonNull(commentsResponse.data[i].user).login === expectedUser &&
-        assertNonNull(commentsResponse.data[i].body).includes(header)
+        stripURLs(assertNonNull(commentsResponse.data[i].body)).includes(
+          stripURLs(header)
+        )
       ) {
         return commentsResponse.data[i].id
       }
@@ -279,6 +292,10 @@ The following doc files are unchanged, but some related sources were changed. Ma
     }
   }
 
+  // Add footer with information about the bot.
+  message += `---
+<sub>[What is this?](${projectURL})</sub>`
+
   return message
 }
 
@@ -431,7 +448,7 @@ export async function run(): Promise<void> {
 
     // ------------------------- Process the analysis -------------------------
     // Common header to identify this bot's messages.
-    const header = '# DocTagChecker\n\n'
+    const header = `# [DocTagChecker](${projectURL})\n\n`
     // Remove the last comment to avoid spam.
     await deleteLastComment(ghToken, header)
     // Set outputs for other workflow steps to use.

src/utils.ts

@@ -3,6 +3,16 @@ import * as path from 'path'
 import * as github from '@actions/github'
 import crypto from 'crypto'
 
+/**
+ * Strips all named URLs down to only the name.
+ * '[leName](someURL)' -> 'leName'
+ * @param text The text to strip.
+ * @returns Stripped text
+ */
+export function stripURLs(text: string): string {
+  return text.replace(/\[(.*)\]\(.*\)/g, '$1')
+}
+
 /**
  * Filter function to remove duplicates in an array.
  * @param value Value to check for duplication