Fix overriding request options from @actions/github

This commit is contained in:
Luke Tomlinson
2022-09-30 10:30:00 -04:00
parent d4560e1570
commit 8445ca871a
7 changed files with 82 additions and 42 deletions

View File

@@ -1,16 +1,13 @@
import * as core from '@actions/core'
import * as exec from '@actions/exec'
import {context, getOctokit} from '@actions/github'
import {defaults as defaultGitHubOptions} from '@actions/github/lib/utils'
import * as glob from '@actions/glob'
import * as io from '@actions/io'
import {retry} from '@octokit/plugin-retry'
import {RequestRequestOptions} from '@octokit/types'
import {callAsyncFunction} from './async-function'
import {
getRetryOptions,
parseNumberArray,
RequestOptions,
RetryOptions
} from './retry-options'
import {getRetryOptions, parseNumberArray, RetryOptions} from './retry-options'
import {wrapRequire} from './wrap-require'
process.on('unhandledRejection', handleError)
@@ -21,7 +18,7 @@ type Options = {
userAgent?: string
previews?: string[]
retry?: RetryOptions
request?: RequestOptions
request?: RequestRequestOptions
}
async function main(): Promise<void> {
@@ -33,7 +30,11 @@ async function main(): Promise<void> {
const exemptStatusCodes = parseNumberArray(
core.getInput('retry-exempt-status-codes')
)
const [retryOpts, requestOpts] = getRetryOptions(retries, exemptStatusCodes)
const [retryOpts, requestOpts] = getRetryOptions(
retries,
exemptStatusCodes,
defaultGitHubOptions
)
const opts: Options = {}
if (debug === 'true') opts.log = console

View File

@@ -1,20 +1,19 @@
import * as core from '@actions/core'
import {OctokitOptions} from '@octokit/core/dist-types/types'
import {RequestRequestOptions} from '@octokit/types'
export type RetryOptions = {
doNotRetry?: number[]
enabled?: boolean
}
export type RequestOptions = {
retries?: number
}
export function getRetryOptions(
retries: number,
exemptStatusCodes: number[]
): [RetryOptions, RequestOptions] {
exemptStatusCodes: number[],
defaultOptions: OctokitOptions
): [RetryOptions, RequestRequestOptions | undefined] {
if (retries <= 0) {
return [{enabled: false}, {}]
return [{enabled: false}, defaultOptions.request]
}
const retryOptions: RetryOptions = {
@@ -25,7 +24,11 @@ export function getRetryOptions(
retryOptions.doNotRetry = exemptStatusCodes
}
const requestOptions: RequestOptions = {
// The GitHub type has some defaults for `options.request`
// see: https://github.com/actions/toolkit/blob/4fbc5c941a57249b19562015edbd72add14be93d/packages/github/src/utils.ts#L15
// We pass these in here so they are not overidden.
const requestOptions: RequestRequestOptions = {
...defaultOptions.request,
retries
}