Merge pull request #283 from technote-space/release/next-v3.0.0

release: v3.0.1

Author: technote-space

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@technote-space/github-action-helper",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Helper to filter GitHub Action.",
   "author": {
     "name": "Technote",

src/api-helper.ts

@@ -1,7 +1,6 @@
 import fs from 'fs';
 import path from 'path';
 import {Context} from '@actions/github/lib/context';
-import {GitHub} from '@actions/github/lib/utils';
 import {PaginateInterface} from '@octokit/plugin-paginate-rest';
 import {RestEndpointMethods} from '@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types';
 import {
@@ -20,6 +19,7 @@ import {exportVariable} from '@actions/core';
 import {Logger} from './index';
 import {getRefForUpdate, isPrRef, getBranch, trimRef, versionCompare, generateNewPatchVersion, generateNewMajorVersion, generateNewMinorVersion} from './utils';
 import {getSender} from './context-helper';
+import {Octokit} from './types';
 
 type PullsUpdateParams = {
   body?: string;
@@ -72,7 +72,7 @@ export default class ApiHelper {
    * @param {boolean|undefined} options.suppressBPError suppress branch protection error?
    */
   constructor(
-    private readonly octokit: InstanceType<typeof GitHub>,
+    private readonly octokit: Octokit,
     private readonly context: Context,
     private readonly logger?: Logger,
     options?: { branch?: string; sender?: string; refForUpdate?: string; suppressBPError?: boolean },

src/index.ts

@@ -3,6 +3,7 @@ import Command from './command';
 import ApiHelper from './api-helper';
 import GitHelper from './git-helper';
 
+export * as Types from './types';
 export * as Utils from './utils';
 export * as ContextHelper from './context-helper';
 

src/types.ts

@@ -0,0 +1,3 @@
+import {GitHub} from '@actions/github/lib/utils';
+
+export type Octokit = InstanceType<typeof GitHub>;

src/utils.ts

@@ -1,9 +1,9 @@
 import fs from 'fs';
 import path from 'path';
 import {getInput} from '@actions/core' ;
-import {GitHub} from '@actions/github/lib/utils';
 import {Context} from '@actions/github/lib/context';
 import {getOctokit as getOctokitInstance} from '@actions/github';
+import {Octokit} from './types';
 
 type RefObject = { ref: string }
 const getRef = (ref: string | RefObject): string => typeof ref === 'string' ? ref : ref.ref;
@@ -89,7 +89,7 @@ export const getRefspec = (ref: string | RefObject, origin = 'origin'): string =
 
 export const getAccessToken = (required: boolean): string => getInput('GITHUB_TOKEN', {required});
 
-export const getOctokit = (token?: string): InstanceType<typeof GitHub> => getOctokitInstance(token ?? getAccessToken(true), {});
+export const getOctokit = (token?: string): Octokit => getOctokitInstance(token ?? getAccessToken(true), {});
 
 export const getActor = (): string => process.env.GITHUB_ACTOR || '';