feat: add method to get pr branch

Author: technote-space

__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}     = Utils;
-const {getBranch, getRefForUpdate, uniqueArray, getBuildInfo, split, getArrayInput, generateNewPatchVersion, sleep} = Utils;
+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;
 
 jest.useFakeTimers();
 
@@ -219,6 +219,24 @@ describe('getBranch', () => {
 	});
 });
 
+describe('getPrBranch', () => {
+	it('should get pr branch', () => {
+		expect(getPrBranch(getContext({
+			payload: {
+				'pull_request': {
+					head: {
+						ref: 'test/abc',
+					},
+				},
+			},
+		}))).toBe('test/abc');
+	});
+
+	it('should not get pr branch', () => {
+		expect(getPrBranch(getContext({}))).toBe('');
+	});
+});
+
 describe('getRefForUpdate', () => {
 	// https://github.com/octokit/rest.js/issues/1308#issuecomment-480532468
 	it('should get ref for update', () => {

src/utils.ts

@@ -52,6 +52,8 @@ export const getBranch = (ref: string | Context, defaultIsEmpty = true): string
 				)
 		);
 
+export const getPrBranch = (context: Context): string => context.payload.pull_request?.head.ref ?? '';
+
 export const getAccessToken = (required: boolean): string => getInput('GITHUB_TOKEN', {required});
 
 export const getActor = (): string => process.env.GITHUB_ACTOR || '';