Merge pull request #212 from technote-space/release/v0.8.4

Release/v0.8.4

Author: technote-space

__tests__/api-helper1.test.ts

@@ -2,6 +2,7 @@
 import nock from 'nock';
 import path from 'path';
 import { Octokit } from '@octokit/rest';
+import { Utils } from '../src';
 import {
 	disableNetConnect,
 	testEnv,
@@ -29,7 +30,7 @@ const context = getContext({
 		number: 123,
 	},
 });
-const octokit = new Octokit({auth: 'token test-token'});
+const octokit = Utils.getOctokit('test-token');
 const logger  = new Logger();
 
 const createCommitResponse = createResponse<Octokit.GitCreateCommitResponse>({

__tests__/api-helper2.test.ts

@@ -2,6 +2,7 @@
 import nock from 'nock';
 import path from 'path';
 import { Octokit } from '@octokit/rest';
+import { Utils } from '../src';
 import {
 	disableNetConnect,
 	testEnv,
@@ -29,7 +30,7 @@ const context = getContext({
 		number: 123,
 	},
 });
-const octokit = new Octokit({auth: 'token test-token'});
+const octokit = Utils.getOctokit('test-token');
 const logger  = new Logger();
 
 const createCommitResponse = createResponse<Octokit.GitCreateCommitResponse>({

__tests__/utils.test.ts

@@ -3,9 +3,9 @@ import path from 'path';
 import { testEnv, getContext, testFs } from '@technote-space/github-action-test-helper';
 import { Utils } from '../src';
 
-const {getWorkspace, getActor, escapeRegExp, getRegExp, getPrefixRegExp, getSuffixRegExp, useNpm, versionCompare}         = Utils;
-const {isSemanticVersioningTagName, isPrRef, getPrMergeRef, getBoolValue, replaceAll, getPrHeadRef, arrayChunk, sleep}    = Utils;
-const {getBranch, getRefForUpdate, uniqueArray, getBuildInfo, split, getArrayInput, generateNewPatchVersion, getPrBranch} = Utils;
+const {getWorkspace, getActor, escapeRegExp, getRegExp, getPrefixRegExp, getSuffixRegExp, useNpm, versionCompare, getOctokit} = Utils;
+const {isSemanticVersioningTagName, isPrRef, getPrMergeRef, getBoolValue, replaceAll, getPrHeadRef, arrayChunk, sleep}        = Utils;
+const {getBranch, getRefForUpdate, uniqueArray, getBuildInfo, split, getArrayInput, generateNewPatchVersion, getPrBranch}     = Utils;
 
 jest.useFakeTimers();
 
@@ -465,3 +465,20 @@ describe('versionCompare', () => {
 		expect(versionCompare('v1.2.3', 'v1.2.4', false)).toBe(-1);
 	});
 });
+
+describe('getOctokit', () => {
+	testEnv();
+
+	it('should use env token', () => {
+		process.env.INPUT_GITHUB_TOKEN = 'input token';
+		expect(() => getOctokit()).not.toThrow();
+	});
+
+	it('should use input token', () => {
+		expect(() => getOctokit('input token')).not.toThrow();
+	});
+
+	it('should throw error', () => {
+		expect(() => getOctokit()).toThrow();
+	});
+});

package.json

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

src/utils.ts

@@ -1,7 +1,9 @@
 import fs from 'fs';
 import path from 'path';
 import { getInput } from '@actions/core' ;
+import { GitHub } from '@actions/github';
 import { Context } from '@actions/github/lib/context';
+import { Octokit } from '@octokit/rest';
 
 const getRef = (ref: string | Context): string => typeof ref === 'string' ? ref : ref.ref;
 
@@ -56,6 +58,16 @@ export const getPrBranch = (context: Context): string => context.payload.pull_re
 
 export const getAccessToken = (required: boolean): string => getInput('GITHUB_TOKEN', {required});
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+// @ts-ignore
+export const getOctokit = (token?: string): Octokit => new GitHub(token ?? getAccessToken(true), {
+	log: {
+		// eslint-disable-next-line @typescript-eslint/no-empty-function
+		warn: function(): void {
+		},
+	},
+});
+
 export const getActor = (): string => process.env.GITHUB_ACTOR || '';
 
 export const escapeRegExp = (text: string): string => text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');

yarn.lock

@@ -17,9 +17,9 @@
     "@octokit/rest" "^16.15.0"
 
 "@actions/http-client@^1.0.3":
-  version "1.0.5"
-  resolved "https://registry.yarnpkg.com/@actions/http-client/-/http-client-1.0.5.tgz#7df8013257cb50bdbe93199b765f0db67e46bbac"
-  integrity sha512-kX9T1EwfohZU/iTHei0nQlykxdTV9xvKMeHYTtYkfkgBKoe2Z0z0IP3ANVYTsFAlycMwLheBhVEBTm2XvGhR1Q==
+  version "1.0.6"
+  resolved "https://registry.yarnpkg.com/@actions/http-client/-/http-client-1.0.6.tgz#6f9267ca50e1d74d8581f4a894a943cd4c97b49a"
+  integrity sha512-LGmio4w98UyGX33b/W6V6Nx/sQHRXZ859YlMkn36wPsXPB82u8xTVlA/Dq2DXrm6lEq9RVmisRJa1c+HETAIJA==
   dependencies:
     tunnel "0.0.6"