fix: add more octokit debugging

README.md

@@ -4,7 +4,7 @@
 
 [![GitHub Marketplace version](https://img.shields.io/github/release/newrelic/repolinter-action.svg?label=Marketplace&logo=github)](https://github.com/marketplace/actions/repolinter-action) ![CI](https://github.com/newrelic/repolinter-action/workflows/CI/badge.svg?event=push) [![codecov](https://codecov.io/gh/newrelic/repolinter-action/branch/main/graph/badge.svg?token=EWYZ7C6RSL)](https://codecov.io/gh/newrelic/repolinter-action) [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/newrelic/repolinter-action.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/newrelic/repolinter-action/context:javascript)
 
-This action runs [Repolinter](https://github.com/todogroup/repolinter) on your repository. Optionally you can also configure this tool to create GitHub issues with the Repolinter output.
+This action runs [Repolinter](https://github.com/todogroup/repolinter) on your repository. Repolinter's optional external dependencies (licensee, linguist, github-markup) are installed using a docker build step. Optionally you can also configure this tool to create GitHub issues with the Repolinter output.
 
 Currently this action uses the [newrelic-forks/repolinter](https://github.com/newrelic-forks/repolinter) fork, which includes a number of changes needed for issue creation support. A [PR](https://github.com/todogroup/repolinter/pull/174) to merge this fork into Repolinter is underway.
 

src/createorUpdateIssue.ts

@@ -30,6 +30,10 @@ type Octo = InstanceType<typeof Octokit>
  * user this action is impersonating (usually github-actions-bot), and that the
  * issue has not been updated by an action run number greater than the current one.
  *
+ * Note: options.labelName should be a label that is unique to the repolinter
+ * action, otherwise there is a small chance this function may attempt to edit
+ * other people's issues.
+ *
  * @param options.owner The owner of the repository to create an issue on
  * @param options.repo The repository to create the issue on
  * @param options.username The username associated with the octokit instance
@@ -49,17 +53,6 @@ type Octo = InstanceType<typeof Octokit>
  * @param options.forceCreateIssue Set to truthy to always create a new issue,
  *     instead of editing the old one. The old issue will automatically be
  *     closed if found.
- * @note options.labelName should be a label that is unique to the
- *     repolinter
- *
- *
- *
- *           action, otherwise there is a small chance this
- *     function may
- *     attempt
- *     to
- *
- *        edit other people's issues.
  * @returns The issue number of the created issue, or null if no issue was created.
  */
 export default async function createOrUpdateIssue(
@@ -141,8 +134,8 @@ export interface FindRepolinterIssueOpts {
  * issue that was created soonest will be returned.
  *
  * This function uses the GitHub REST API to perform a search that can be
- * described with the following search query: ``` type:issue repo:<the current
- * repo> creator:<username> label:<label-name> sort:author-date-desc\ ```
+ * described with the following search query: `type:issue repo:<the current
+ * repo> creator:<username> label:<label-name> sort:author-date-desc\`
  *
  * @param client The authenticated octokit client to use
  * @param options.owner The owner of the repository to search

src/entry.ts

@@ -1,19 +1,8 @@
 import run from './main'
 
 /**
- * @file This file serves as the "entry"
- * you can check out main.ts for
- *
- *
- *     the
- *
- *
- *
- *
- *
- *
- *           actual
- * "main" function.
+ * @file This file serves as the "entry" you can check out main.ts for the
+ *     actual "main" function.
  */
 
 run()

src/getOctokit.ts

@@ -2,37 +2,9 @@ import {Octokit as ActionKit} from '@octokit/action'
 import {retry} from '@octokit/plugin-retry'
 
 /**
- * @file This file serves as a centralized
- * location to setup Octokit with
- *
- *
- *
- *
- *
- *      the
- *
- *
- *
- *           appropriate
- * plugins and authentication. All
- *     Octokit
- *
- *
- *
- *
- *           instances
- * in
- *
- *       this
- *
- *       action should come
- *     from this
- *     file
- *
- *
- *
- *       to
- * prevent type conflicts.
+ * @file This file serves as a centralized location to setup Octokit with the
+ *     appropriate plugins and authentication. All Octokit instances in this
+ *     action should come from this file to prevent type conflicts.
  */
 
 // strip plugin types to make testing easier

src/main.ts

@@ -107,8 +107,10 @@ export default async function run(disableRetry?: boolean): Promise<void> {
           error: core.error
         }
       })
-      octokit.hook.before('request', options =>
-        core.debug(`${options.method} ${options.url}`)
+      octokit.hook.after('request', (response, options) =>
+        core.debug(
+          `${options.method} ${options.url}: ${JSON.stringify(response)}`
+        )
       )
 
       const [owner, repo] = REPO.split('/')