Merge pull request #288 from technote-space/release/next-v3.0.4

release: v3.1.0

Author: technote-space

__tests__/context-helper.test.ts

@@ -7,7 +7,7 @@ import {
 import {testEnv, getContext} from '@technote-space/github-action-test-helper';
 import {Logger, ContextHelper} from '../src';
 
-const {isRelease, isPush, isPr, isIssue, isCron, isCustomEvent, isCreateTag} = ContextHelper;
+const {isRelease, isPush, isPr, isIssue, isCron, isCustomEvent, isManualEvent, isCreateTag} = ContextHelper;
 const {getGitUrl, getRepository, getTagName, getSender, showActionInfo}      = ContextHelper;
 
 describe('isRelease', () => {
@@ -94,6 +94,20 @@ describe('isCustomEvent', () => {
   });
 });
 
+describe('isManualEvent', () => {
+  it('should return true', () => {
+    expect(isManualEvent(getContext({
+      eventName: 'workflow_dispatch',
+    }))).toBe(true);
+  });
+
+  it('should return false', () => {
+    expect(isManualEvent(getContext({
+      eventName: 'release',
+    }))).toBe(false);
+  });
+});
+
 describe('isCreateTag', () => {
   it('should return true', () => {
     expect(isCreateTag(getContext({

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@technote-space/github-action-helper",
-  "version": "3.0.4",
+  "version": "3.1.0",
   "description": "Helper to filter GitHub Action.",
   "author": {
     "name": "Technote",
@@ -28,25 +28,25 @@
   "dependencies": {
     "@actions/core": "^1.2.4",
     "@actions/github": "^4.0.0",
-    "@octokit/plugin-rest-endpoint-methods": "^4.0.0",
+    "@octokit/plugin-rest-endpoint-methods": "^4.1.0",
     "shell-escape": "^0.2.0",
     "sprintf-js": "^1.1.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^9.0.1",
-    "@commitlint/config-conventional": "^9.0.1",
-    "@technote-space/github-action-test-helper": "^0.5.1",
+    "@commitlint/cli": "^9.1.1",
+    "@commitlint/config-conventional": "^9.1.1",
+    "@technote-space/github-action-test-helper": "^0.5.3",
     "@types/jest": "^26.0.4",
-    "@types/node": "^14.0.20",
-    "@typescript-eslint/eslint-plugin": "^3.6.0",
-    "@typescript-eslint/parser": "^3.6.0",
+    "@types/node": "^14.0.23",
+    "@typescript-eslint/eslint-plugin": "^3.6.1",
+    "@typescript-eslint/parser": "^3.6.1",
     "eslint": "^7.4.0",
     "husky": "^4.2.5",
     "jest": "^26.1.0",
     "jest-circus": "^26.1.0",
     "lint-staged": "^10.2.11",
     "nock": "^13.0.2",
-    "ts-jest": "^26.1.1",
+    "ts-jest": "^26.1.2",
     "typescript": "^3.9.6"
   },
   "publishConfig": {

src/context-helper.ts

@@ -15,6 +15,8 @@ export const isCron = (context: Context): boolean => 'schedule' === context.even
 
 export const isCustomEvent = (context: Context): boolean => 'repository_dispatch' === context.eventName;
 
+export const isManualEvent = (context: Context): boolean => 'workflow_dispatch' === context.eventName;
+
 export const isCreateTag = (context: Context): boolean => 'create' === context.eventName && 'tag' === context.payload.ref_type;
 
 export const getTagName = (context: Context): string => isRelease(context) ? context.payload.release.tag_name : (/^refs\/tags\//.test(context.ref) ? context.ref.replace(/^refs\/tags\//, '') : '');