feat: exclude tag push

Author: technote-space

__tests__/utils/misc.test.ts

@@ -1,10 +1,48 @@
 /* eslint-disable no-magic-numbers */
 import { resolve } from 'path';
 import { testEnv, getOctokit, generateContext } from '@technote-space/github-action-test-helper';
-import { getRunId, getTargetBranch } from '../../src/utils/misc';
+import { isExcludeContext, getRunId, getTargetBranch } from '../../src/utils/misc';
 
 const rootDir = resolve(__dirname, '../..');
 
+describe('isExcludeContext', () => {
+	testEnv(rootDir);
+
+	it('should true 1', () => {
+		expect(isExcludeContext(generateContext({event: 'push', ref: 'refs/tags/v1.2.3'}))).toBe(true);
+	});
+
+	it('should true 2', () => {
+		process.env.INPUT_EXCLUDE_MERGED = 'true';
+		expect(isExcludeContext(generateContext({event: 'push', ref: 'refs/heads/feature/change'}, {
+			payload: {
+				'head_commit': {
+					message: 'Merge pull request #260 from test',
+				},
+			},
+		}))).toBe(true);
+	});
+
+	it('should false 1', () => {
+		process.env.INPUT_EXCLUDE_TAG_PUSH = 'false';
+		expect(isExcludeContext(generateContext({event: 'push', ref: 'refs/tags/v1.2.3'}))).toBe(false);
+	});
+
+	it('should false 2', () => {
+		expect(isExcludeContext(generateContext({event: 'push', ref: 'refs/heads/feature/change'}))).toBe(false);
+	});
+
+	it('should false 3', () => {
+		expect(isExcludeContext(generateContext({event: 'push', ref: 'refs/heads/feature/change'}, {
+			payload: {
+				'head_commit': {
+					message: 'Merge pull request #260 from test',
+				},
+			},
+		}))).toBe(false);
+	});
+});
+
 describe('getRunId', () => {
 	testEnv(rootDir);
 

action.yml

@@ -17,6 +17,10 @@ inputs:
     description: Prefix to detect merge message.
     required: false
     default: 'Merge pull request'
+  EXCLUDE_TAG_PUSH:
+    description: Whether to exclude tag push.
+    required: false
+    default: 'true'
 
 branding:
   icon: 'x-circle'

src/utils/misc.ts

@@ -5,7 +5,12 @@ import { ContextHelper, Utils } from '@technote-space/github-action-helper';
 
 const getMergeMessagePrefix   = (): RegExp => Utils.getPrefixRegExp(getInput('MERGE_MESSAGE_PREFIX'));
 const isExcludeMerged         = (): boolean => Utils.getBoolValue(getInput('EXCLUDE_MERGED'));
-export const isExcludeContext = (context: Context): boolean => ContextHelper.isPush(context) && isExcludeMerged() && getMergeMessagePrefix().test(context.payload.head_commit.message);
+const isExcludeTagPush        = (): boolean => Utils.getBoolValue(getInput('EXCLUDE_TAG_PUSH'));
+export const isExcludeContext = (context: Context): boolean =>
+	ContextHelper.isPush(context) && (
+		(isExcludeTagPush() && Utils.isTagRef(context)) ||
+		(isExcludeMerged() && getMergeMessagePrefix().test(context.payload.head_commit.message))
+	);
 export const isNotExcludeRun  = (run: Octokit.ActionsListWorkflowRunsResponseWorkflowRunsItem): boolean => !isExcludeMerged() || !getMergeMessagePrefix().test(run.head_commit.message);
 
 export const getRunId = (): number => Number(process.env.GITHUB_RUN_ID);