Review @actions/github for updates

Author: ncalteen

README.md

@@ -21,6 +21,7 @@ currently implemented by this tool.
 | ---------------------------------------------------------------------- | -------- |
 | [`@actions/artifact`](https://www.npmjs.com/package/@actions/artifact) | `2.3.2`  |
 | [`@actions/core`](https://www.npmjs.com/package/@actions/core)         | `1.11.1` |
+| [`@actions/github`](https://www.npmjs.com/package/@actions/github)     | `6.0.0`  |
 
 ## Changelog
 

src/stubs/env.ts

@@ -17,8 +17,6 @@ export const EnvMeta: EnvMetadata = {
 
 /**
  * Resets the environment metadata
- *
- * @returns void
  */
 export function ResetEnvMetadata(): void {
   EnvMeta.actionFile = ''

src/stubs/github/context.ts

@@ -1,6 +1,9 @@
+/**
+ * Last Reviewed Commit: https://github.com/actions/toolkit/blob/930c89072712a3aac52d74b23338f00bb0cfcb24/packages/github/src/context.ts
+ */
 import { existsSync, readFileSync } from 'fs'
 import { EOL } from 'os'
-import { WebhookPayload } from './interfaces.js'
+import type { WebhookPayload } from './interfaces.js'
 
 export class Context {
   /**
@@ -29,7 +32,6 @@ export class Context {
     this.payload = {}
 
     if (process.env.GITHUB_EVENT_PATH) {
-      console.log(process.env.GITHUB_EVENT_PATH)
       if (existsSync(process.env.GITHUB_EVENT_PATH)) {
         this.payload = JSON.parse(
           readFileSync(process.env.GITHUB_EVENT_PATH, { encoding: 'utf8' })
@@ -76,12 +78,11 @@ export class Context {
     }
 
     /* istanbul ignore next */
-    if (this.payload.repository) {
+    if (this.payload.repository)
       return {
         owner: this.payload.repository.owner.login,
         repo: this.payload.repository.name
       }
-    }
 
     /* istanbul ignore next */
     throw new Error(

src/stubs/github/github.ts

@@ -1,8 +1,13 @@
 /**
- * @github/local-action Modified
+ * Last Reviewed Commit: https://github.com/actions/toolkit/blob/930c89072712a3aac52d74b23338f00bb0cfcb24/packages/github/src/github.ts
+ *
+ * @remarks
+ *
+ * - The `context` export is removed and defined in `commands/run.ts`. This is
+ *   so that the context can be defined after the environment file is loaded.
  */
 
-import { OctokitOptions, OctokitPlugin } from '@octokit/core/types'
+import type { OctokitOptions, OctokitPlugin } from '@octokit/core/types'
 import { GitHub, getOctokitOptions } from './utils.js'
 
 /**

src/stubs/github/interfaces.ts

@@ -1,5 +1,11 @@
+/**
+ * Last Reviewed Commit: https://github.com/actions/toolkit/blob/930c89072712a3aac52d74b23338f00bb0cfcb24/packages/github/src/interfaces.ts
+ */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
+/**
+ * Repository Payload
+ */
 export interface PayloadRepository {
   [key: string]: any
   full_name?: string
@@ -12,6 +18,9 @@ export interface PayloadRepository {
   html_url?: string
 }
 
+/**
+ * Webhook Payload
+ */
 export interface WebhookPayload {
   [key: string]: any
   repository?: PayloadRepository

src/stubs/github/internal/utils.ts

@@ -1,12 +1,12 @@
 /**
- * @github/local-action Modified
+ * Last Reviewed Commit: https://github.com/actions/toolkit/blob/930c89072712a3aac52d74b23338f00bb0cfcb24/packages/github/src/internal/utils.ts
  */
 /* istanbul ignore file */
 
 import * as httpClient from '@actions/http-client'
-import { OctokitOptions } from '@octokit/core/types'
+import { type OctokitOptions } from '@octokit/core/types'
 import * as http from 'http'
-import { ProxyAgent, fetch } from 'undici'
+import { type ProxyAgent, fetch } from 'undici'
 
 /**
  * Returns the auth string to use for the request.
@@ -50,8 +50,7 @@ export function getProxyAgentDispatcher(
 ): ProxyAgent | undefined {
   const hc = new httpClient.HttpClient()
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  return hc.getAgentDispatcher(destinationUrl) as any
+  return hc.getAgentDispatcher(destinationUrl) as ProxyAgent | undefined
 }
 
 /**
@@ -79,5 +78,5 @@ export function getProxyFetch(destinationUrl: string): typeof fetch {
  * @returns Base URL
  */
 export function getApiBaseUrl(): string {
-  return process.env['GITHUB_API_URL'] || 'https://api.github.com'
+  return process.env.GITHUB_API_URL || 'https://api.github.com'
 }

src/stubs/github/utils.ts

@@ -1,5 +1,10 @@
 /**
- * @github/local-action Modified
+ * Last Reviewed Commit: https://github.com/actions/toolkit/blob/930c89072712a3aac52d74b23338f00bb0cfcb24/packages/github/src/utils.ts
+ *
+ * @remarks
+ *
+ * - The `context` export is removed and defined in `commands/run.ts`. This is
+ *   so that the context can be defined after the environment file is loaded.
  */
 
 import { Octokit } from '@octokit/core'
@@ -39,7 +44,6 @@ export function getOctokitOptions(
   const opts = Object.assign({}, options || {})
 
   const auth = Utils.getAuthString(token, opts)
-
   if (auth) opts.auth = auth
 
   return opts