feat: Build for release

Author: GitHub Actions

README.ja.md

@@ -21,20 +21,24 @@
 - [スクリーンショット](#%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88)
 - [インストール](#%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB)
 - [オプション](#%E3%82%AA%E3%83%97%E3%82%B7%E3%83%A7%E3%83%B3)
-  - [PACKAGE_MANAGER](#package_manager)
   - [BUILD_COMMAND](#build_command)
+  - [DELETE_TARGETS](#delete_targets)
+  - [PACKAGE_MANAGER](#package_manager)
   - [COMMIT_MESSAGE](#commit_message)
   - [COMMIT_NAME](#commit_name)
   - [COMMIT_EMAIL](#commit_email)
   - [BRANCH_NAME](#branch_name)
-  - [CLEAN_TARGETS](#clean_targets)
   - [BUILD_COMMAND_TARGET](#build_command_target)
   - [CREATE_MAJOR_VERSION_TAG](#create_major_version_tag)
   - [CREATE_MINOR_VERSION_TAG](#create_minor_version_tag)
   - [CREATE_PATCH_VERSION_TAG](#create_patch_version_tag)
   - [FETCH_DEPTH](#fetch_depth)
   - [TEST_TAG_PREFIX](#test_tag_prefix)
+  - [CLEAN_TEST_TAG](#clean_test_tag)
   - [ORIGINAL_TAG_PREFIX](#original_tag_prefix)
+- [Execute commands](#execute-commands)
+  - [ビルド](#%E3%83%93%E3%83%AB%E3%83%89)
+  - [ファイル削除](#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E5%89%8A%E9%99%A4)
 - [Action イベント詳細](#action-%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88%E8%A9%B3%E7%B4%B0)
   - [対象イベント](#%E5%AF%BE%E8%B1%A1%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88)
   - [condition](#condition)
@@ -77,56 +81,45 @@
 [対象イベントの詳細](#action-%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88%E8%A9%B3%E7%B4%B0)
 
 ## オプション
+### BUILD_COMMAND
+ビルド用コマンド  
+default: `''`  
+[More details of execute command](#execute-commands)
+
+### DELETE_TARGETS
+[More details of execute command](#execute-commands)
+リリース前に削除するファイルやディレクトリ (カンマ区切り)  
+default: `.[!.]*,__tests__,src,*.js,*.ts,*.json,*.lock,_config.yml`  
+絶対パスや `..` は使用できません。  
+
 ### PACKAGE_MANAGER
 依存関係のインストールに使用するパッケージマネージャー  
 `yarn.lock` や `package-lock.json` がある場合は自動で使用するパッケージマネージャーを決定しますが、このオプションで強制することができます。  
 （`npm` または `yarn`）  
 default: `''`  
 例：`npm`  
 
-### BUILD_COMMAND
-ビルド用コマンド  
-default: `''`  
-- `build`、 `production` または `prod` が package.json の scripts に含まれる場合、ビルド用のコマンドとしてそれを使用します。([BUILD_COMMAND_TARGET](#build_command_target) で変更可能です)  
-- `npm run install` や `yarn install` のようなインストール用コマンドが存在しない場合、インストール用コマンドが追加されます。  
-- ビルド用コマンドが空の場合、いくつかのファイルが削除されます。 (詳細：[CLEAN_TARGETS](#clean_targets)).  
-
-したがって、`BUILD_COMMAND` が設定されていない かつ package.json に `build` が存在する場合、以下のコマンドが実行されます。
-```shell
-yarn install
-yarn build
-yarn install --production
-rm -rdf .[!.]*
-...
-rm -rdf _config.yml
-```
-
 ### COMMIT_MESSAGE
 コミット時に設定するメッセージ  
 default: `'feat: Build for release'`
 
 ### COMMIT_NAME
 コミット時に設定する名前  
-default: `'GitHub Actions'`
+default: `'github-actions[bot]'`
 
 ### COMMIT_EMAIL
 コミット時に設定するメールアドレス  
-default: `'example@example.com'`
+default: `'41898282+github-actions[bot]@users.noreply.github.com'`
 
 ### BRANCH_NAME
 GitHub Actions 用のブランチ名  
 default: `'gh-actions'`
 
-### CLEAN_TARGETS
-リリース前に削除するファイルやディレクトリ (カンマ区切り)  
-default: `.[!.]*,__tests__,src,*.js,*.ts,*.json,*.lock,_config.yml`  
-絶対パスや `..` は使用できません。  
-`BUILD_COMMAND`が指定されている場合、このパラメーターは無視されます。  
-
 ### BUILD_COMMAND_TARGET
 ビルド用コマンド検索ターゲット  
 default: `''`  
-例：`compile`
+例：`compile`  
+このオプションが設定されていない場合、`build`, `production`, `prod` と `package` が使用されます。  
 
 ### CREATE_MAJOR_VERSION_TAG
 メジャーバージョンタグ(例：v1)を作成するかどうか  
@@ -150,12 +143,53 @@ default: `3`
 ### TEST_TAG_PREFIX
 テスト用タグのプリフィックス  
 default: `''`  
-例：`'test/'`
+例：`'test/'`  
+
+### CLEAN_TEST_TAG
+テストタグを掃除するかどうか  
+default: `'false'`  
+例：`'true'`  
 
 ### ORIGINAL_TAG_PREFIX
 元のタグを残す際に付与するプリフィックス  
 default: `''`  
-例：`'original/'`
+例：`'original/'`  
+
+## Execute commands
+### ビルド
+- `build`、 `production` または `prod` が package.json の scripts に含まれる場合、ビルド用のコマンドとしてそれを使用します。([BUILD_COMMAND_TARGET](#build_command_target) で変更可能です)  
+- `npm run install` や `yarn install` のようなインストール用コマンドが存在しない場合、インストール用コマンドが追加されます。  
+
+したがって、`BUILD_COMMAND` が設定されていない かつ package.json に `build` が存在する場合、以下のコマンドが実行されます。
+
+```shell
+yarn install
+yarn build
+yarn install --production
+```
+
+### ファイル削除
+`GitHub Actions` の実行には「ビルドに使用するソース」や「テストファイル」、「テストの設定」などを必要としません。  
+そして `GitHub Actions` は使用されるたびにダウンロードされるため、ファイルは少ないほうが良いです。  
+
+`DELETE_TARGETS` オプションはこの目的のために使用されます。  
+default: `.[!.]*,__tests__,src,*.js,*.ts,*.json,*.lock,_config.yml`  
+
+```shell
+rm -rdf .[!.]*
+rm -rdf *.js
+rm -rdf *.ts
+rm -rdf *.json
+rm -rdf *.lock
+rm -rdf __tests__ src '_config.yml'
+```
+
+このデフォルト値は「TypeScriptのActionテンプレート」や「JavaScriptのActionテンプレート」の使用を想定した値になっています。  
+https://github.com/actions/typescript-action  
+https://github.com/actions/javascript-action  
+
+不要なファイルが削除された`GitHub Actions`の例を以下で確認できます。  
+https://github.com/technote-space/release-github-actions/tree/gh-actions
 
 ## Action イベント詳細
 ### 対象イベント

README.md

@@ -21,20 +21,24 @@ Once you create a new tag, this action will automatically
 - [Screenshots](#screenshots)
 - [Installation](#installation)
 - [Options](#options)
-  - [PACKAGE_MANAGER](#package_manager)
   - [BUILD_COMMAND](#build_command)
+  - [DELETE_TARGETS](#delete_targets)
+  - [PACKAGE_MANAGER](#package_manager)
   - [COMMIT_MESSAGE](#commit_message)
   - [COMMIT_NAME](#commit_name)
   - [COMMIT_EMAIL](#commit_email)
   - [BRANCH_NAME](#branch_name)
-  - [CLEAN_TARGETS](#clean_targets)
   - [BUILD_COMMAND_TARGET](#build_command_target)
   - [CREATE_MAJOR_VERSION_TAG](#create_major_version_tag)
   - [CREATE_MINOR_VERSION_TAG](#create_minor_version_tag)
   - [CREATE_PATCH_VERSION_TAG](#create_patch_version_tag)
   - [FETCH_DEPTH](#fetch_depth)
   - [TEST_TAG_PREFIX](#test_tag_prefix)
+  - [CLEAN_TEST_TAG](#clean_test_tag)
   - [ORIGINAL_TAG_PREFIX](#original_tag_prefix)
+- [Execute commands](#execute-commands)
+  - [Build](#build)
+  - [Delete files](#delete-files)
 - [Action event details](#action-event-details)
   - [Target events](#target-events)
   - [condition](#condition)
@@ -77,56 +81,44 @@ Once you create a new tag, this action will automatically
 [More details of target event](#action-event-details)
 
 ## Options
+### BUILD_COMMAND
+Build command.  
+default: `''`  
+[More details of execute command](#execute-commands)
+
+### DELETE_TARGETS
+Files or directories to delete before release (Comma separated).  
+default: `.[!.]*,__tests__,src,*.js,*.ts,*.json,*.lock,_config.yml`  
+Absolute path and `..` are not permitted to use.  
+[More details of execute command](#execute-commands)
+
 ### PACKAGE_MANAGER
 Package manager to use to install dependencies.  
 If there is `yarn.lock` or` package-lock.json`, the action automatically determines the package manager to use, but this option can be used to specify it explicitly.  
 （`npm` or `yarn`）  
 default: `''`
 
-### BUILD_COMMAND
-Build command.  
-default: `''`  
-- If package.json includes `build` or `production` or `prod` in scripts, the command is used for build. (You can change this with [BUILD_COMMAND_TARGET](#build_command_target))  
-- If command does not have install command like `npm run install` or `yarn install`, install commands are added.  
-- If command is not provided, some files are deleted (see [CLEAN_TARGETS](#clean_targets)).
-
-so if `BUILD_COMMAND` is not provided and package.json has `build` script,
-the following commands are executed.
-```shell
-yarn install
-yarn build
-yarn install --production
-rm -rdf .[!.]*
-...
-rm -rdf _config.yml
-```
-
 ### COMMIT_MESSAGE
 Commit message.  
 default: `'feat: Build for release'`
 
 ### COMMIT_NAME
 Commit name.  
-default: `'GitHub Actions'`
+default: `'github-actions[bot]'`
 
 ### COMMIT_EMAIL
 Commit email.  
-default: `'example@example.com'`
+default: `'41898282+github-actions[bot]@users.noreply.github.com'`
 
 ### BRANCH_NAME
 Branch name for `GitHub Actions` release.  
 default: `'gh-actions'`
 
-### CLEAN_TARGETS
-Files or directories to delete before release (Comma separated).  
-default: `.[!.]*,__tests__,src,*.js,*.ts,*.json,*.lock,_config.yml`  
-Absolute path and `..` are not permitted to use.  
-This parameter is ignored if `BUILD_COMMAND` is provided.  
-
 ### BUILD_COMMAND_TARGET
 Command for search build command.  
 default: `''`  
-e.g. `compile`
+e.g. `compile`  
+If this option is not provided, `build`, `production`, `prod` and `package` are used.
 
 ### CREATE_MAJOR_VERSION_TAG
 Whether to create major version tag (e.g. v1).  
@@ -150,12 +142,54 @@ default: `3`
 ### TEST_TAG_PREFIX
 Prefix for test tag.  
 default: `''`  
-e.g. `'test/'`
+e.g. `'test/'`  
+
+### CLEAN_TEST_TAG
+Whether to clean test tag.  
+default: `'false'`  
+e.g. `'true'`  
 
 ### ORIGINAL_TAG_PREFIX
 Prefix to add when leaving the original tag.  
 default: `''`  
-e.g. `'original/'`
+e.g. `'original/'`  
+
+## Execute commands
+### Build
+- If package.json includes `build`, `production`, `prod` or `package` in scripts, the command is used for build. (You can change this with [BUILD_COMMAND_TARGET](#build_command_target))  
+- If command does not have install command like `npm run install` or `yarn install`, install commands are added.  
+
+so if `BUILD_COMMAND` is not provided and package.json has `build` script,
+the following commands are executed for build.
+
+```shell
+yarn install
+yarn build
+yarn install --production
+```
+
+### Delete files
+To execute `GitHub Actions`, `src files used for build`, `test files`, `test settings`, etc. are not required.  
+And `GitHub Actions` is downloaded every time when it is used, so fewer files are better.  
+
+`DELETE_TARGETS` option is used for this purpose.  
+default: `.[!.]*,__tests__,src,*.js,*.ts,*.json,*.lock,_config.yml`  
+
+```shell
+rm -rdf .[!.]*
+rm -rdf *.js
+rm -rdf *.ts
+rm -rdf *.json
+rm -rdf *.lock
+rm -rdf __tests__ src '_config.yml'
+```
+
+The default setting assumes the use of `Action template for TypeScript` or `Action template for JavaScript`.  
+https://github.com/actions/typescript-action  
+https://github.com/actions/javascript-action  
+
+You can see an example of `GitHub Actions` with unnecessary files deleted below.  
+https://github.com/technote-space/release-github-actions/tree/gh-actions
 
 ## Action event details
 ### Target events

action.yml

@@ -1,6 +1,9 @@
 name: Release GitHub Actions
-description: This is a GitHub Action that automates the release of GitHub Action.
+
+description: This is a GitHub Actions that automates the release of GitHub Actions.
+
 author: technote-space
+
 inputs:
   GITHUB_TOKEN:
     description: Secret GitHub API token to use for making API requests.
@@ -16,14 +19,14 @@ inputs:
     default: 'feat: Build for release'
   COMMIT_NAME:
     description: Git commit name.
-    default: 'GitHub Actions'
+    default: 'github-actions[bot]'
   COMMIT_EMAIL:
     description: Git commit email.
-    default: 'example@example.com'
+    default: '41898282+github-actions[bot]@users.noreply.github.com'
   BRANCH_NAME:
     description: Branch name.
     default: 'gh-actions'
-  CLEAN_TARGETS:
+  DELETE_TARGETS:
     description: Files or directories to delete before release. (Comma separated)
     default: '.[!.]*,__tests__,src,*.js,*.ts,*.json,*.lock,_config.yml'
   BUILD_COMMAND_TARGET:
@@ -45,14 +48,19 @@ inputs:
     description: Limit fetching to the specified number of commits from the tip of each remote branch history.
     default: '3'
   TEST_TAG_PREFIX:
-    description: Tag name prefix for test
+    description: Tag name prefix for test.
     default: ''
+  CLEAN_TEST_TAG:
+    description: Whether to clean test tag.
+    default: false
   ORIGINAL_TAG_PREFIX:
-    description: Tag name prefix for original tag
+    description: Tag name prefix for original tag.
     default: ''
+
 branding:
   icon: 'tag'
   color: 'green'
+
 runs:
   using: node12
   main: lib/main.js

build.json

@@ -1 +1 @@
-{"owner":"technote-space","repo":"release-github-actions","sha":"cb0e475bc22e1aca897239ffeae4001309c25050","ref":"refs/tags/v1.7.3","tagName":"v1.7.3","branch":"gh-actions","tags":["v1","v1.7","v1.7.3"],"updated_at":"2019-12-08T12:29:36.279Z"}
+{"owner":"technote-space","repo":"release-github-actions","sha":"6d981505947fa0a939a019876c320e3dfe1f5a20","ref":"refs/tags/test/v2.0.0","tagName":"test/v2.0.0","branch":"gh-actions","tags":["test/v2","test/v2.0","test/v2.0.0"],"updated_at":"2019-12-08T18:09:05.788Z"}

lib/constant.js

@@ -2,10 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const misc_1 = require("./utils/misc");
 exports.DEFAULT_COMMIT_MESSAGE = 'feat: Build for release';
-exports.DEFAULT_COMMIT_NAME = 'GitHub Actions';
-exports.DEFAULT_COMMIT_EMAIL = 'example@example.com';
+exports.DEFAULT_COMMIT_NAME = 'github-actions[bot]';
+exports.DEFAULT_COMMIT_EMAIL = '41898282+github-actions[bot]@users.noreply.github.com';
 exports.DEFAULT_BRANCH_NAME = 'gh-actions';
-exports.DEFAULT_CLEAN_TARGETS = '.[!.]*,__tests__,src,*.js,*.ts,*.json,*.lock,_config.yml';
 exports.DEFAULT_OUTPUT_BUILD_INFO_FILENAME = '';
 exports.DEFAULT_FETCH_DEPTH = 3;
 exports.DEFAULT_TEST_TAG_PREFIX = '';
@@ -14,6 +13,7 @@ exports.DEFAULT_SEARCH_BUILD_COMMAND_TARGETS = [
     'build',
     'production',
     'prod',
+    'package',
 ];
 exports.TARGET_EVENTS = {
     'create': [