feat: Build for release

Author: technote-space

README.ja.md

@@ -0,0 +1,214 @@
+# Release GitHub Actions
+
+[![Build Status](https://github.com/technote-space/release-github-actions/workflows/Build/badge.svg)](https://github.com/technote-space/release-github-actions/actions)
+[![Coverage Status](https://coveralls.io/repos/github/technote-space/release-github-actions/badge.svg?branch=master)](https://coveralls.io/github/technote-space/release-github-actions?branch=master)
+[![CodeFactor](https://www.codefactor.io/repository/github/technote-space/release-github-actions/badge)](https://www.codefactor.io/repository/github/technote-space/release-github-actions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/technote-space/release-github-actions/blob/master/LICENSE)
+
+*Read this in other languages: [English](README.md), [日本語](README.ja.md).*
+
+これは GitHub Action のリリースを自動化するための GitHub Action です。  
+タグを作成するとこのアクションは自動で以下を行います。
+1. ビルド実行
+1. リリース用ブランチ作成
+1. リリース用ブランチに[タグ](#tags)を張り替え
+1. 同じタグ名 かつ 公開済みのリリースが存在する場合、再度公開 (タグを張り替えた場合、リリースが下書き状態になるため)
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**
+
+- [スクリーンショット](#%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)
+- [必要なパラメータ](#%E5%BF%85%E8%A6%81%E3%81%AA%E3%83%91%E3%83%A9%E3%83%A1%E3%83%BC%E3%82%BF)
+  - [ACCESS_TOKEN](#access_token)
+- [オプション](#%E3%82%AA%E3%83%97%E3%82%B7%E3%83%A7%E3%83%B3)
+  - [BUILD_COMMAND](#build_command)
+  - [COMMIT_MESSAGE](#commit_message)
+  - [COMMIT_NAME](#commit_name)
+  - [COMMIT_EMAIL](#commit_email)
+  - [BRANCH_NAME](#branch_name)
+  - [CLEAN_TARGETS](#clean_targets)
+  - [CREATE_MAJOR_VERSION_TAG](#create_major_version_tag)
+  - [CREATE_MINOR_VERSION_TAG](#create_minor_version_tag)
+  - [OUTPUT_BUILD_INFO_FILENAME](#output_build_info_filename)
+  - [FETCH_DEPTH](#fetch_depth)
+  - [TEST_TAG_PREFIX](#test_tag_prefix)
+  - [ORIGINAL_TAG_PREFIX](#original_tag_prefix)
+- [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)
+- [動機](#%E5%8B%95%E6%A9%9F)
+- [補足](#%E8%A3%9C%E8%B6%B3)
+  - [Tags](#tags)
+- [このアクションを使用しているアクションの例](#%E3%81%93%E3%81%AE%E3%82%A2%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3%E3%82%92%E4%BD%BF%E7%94%A8%E3%81%97%E3%81%A6%E3%81%84%E3%82%8B%E3%82%A2%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%AE%E4%BE%8B)
+- [Author](#author)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## スクリーンショット
+1. リリース作成前  
+   ![Before publish release](https://raw.githubusercontent.com/technote-space/release-github-actions/images/screenshot-1.png)
+1. リリースを作成 (タグを作成)  
+   ![Publish release](https://raw.githubusercontent.com/technote-space/release-github-actions/images/screenshot-2.png)
+1. GitHub Action 実行中  
+   ![Running GitHub Action](https://raw.githubusercontent.com/technote-space/release-github-actions/images/screenshot-3.png)
+1. GitHub Action 実行後  
+   ![After running GitHub Action](https://raw.githubusercontent.com/technote-space/release-github-actions/images/screenshot-4.png)
+
+## インストール
+1. workflow を設定  
+   例： `.github/workflows/release.yml`
+   ```yaml
+   on: push
+   name: Release
+   jobs:
+     release:
+       name: Release GitHub Actions
+       runs-on: ubuntu-latest
+       steps:
+         - name: Release GitHub Actions
+           uses: technote-space/release-github-actions@v1
+           with:
+             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+             ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+   ```
+
+## 必要なパラメータ
+### ACCESS_TOKEN
+1. public_repo または repo のスコープで [personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) を生成。  
+(プライベートリポジトリの場合 repo が必要です)  
+1. [Secretsに保存](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables)
+
+## オプション
+### BUILD_COMMAND
+ビルド用コマンド  
+default: `''`  
+- build、 production または prod package.json の scripts に含まれる場合、ビルド用のコマンドとしてそれを使用します。  
+- `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'`
+
+### COMMIT_EMAIL
+コミット時に設定するメールアドレス  
+default: `'[email protected]'`
+
+### BRANCH_NAME
+GitHub Action 用のブランチ名  
+default: `'gh-actions'`
+
+### CLEAN_TARGETS
+リリース前に削除するファイルやディレクトリ (カンマ区切り)  
+default: `.[!.]*,__tests__,src,*.js,*.ts,*.json,*.lock,_config.yml`  
+絶対パスや `..` は使用できません。  
+
+### CREATE_MAJOR_VERSION_TAG
+メジャーバージョンタグ(例：v1)を作成するかどうか  
+default: `true`  
+[タグの詳細](#tags)
+
+### CREATE_MINOR_VERSION_TAG
+マイナーバージョンタグ(例：v1.2)を作成するかどうか  
+default: `true`  
+[タグの詳細](#tags)
+
+### OUTPUT_BUILD_INFO_FILENAME
+ビルド情報を出力するファイル名  
+default: `''`  
+絶対パスや `..` は使用できません。  
+この設定が空でない場合、以下のような情報が出力されます。  
+```json
+{
+  "tagName": "${tagName}",
+  "branch": "${branch}",
+  "tags": [
+    "${created_tag_1}",
+    "...",
+    "${created_tag_n}"
+  ],
+  "updated_at": "${updated_at}"
+}
+```
+
+### FETCH_DEPTH
+取得するコミット履歴の制限数  
+default: `3`  
+
+### TEST_TAG_PREFIX
+テスト用タグのプリフィックス  
+default: `''`  
+例：`'test/'`
+
+### ORIGINAL_TAG_PREFIX
+元のタグを残す際に付与するプリフィックス  
+default: `''`  
+例：`'original/'`
+
+## Action イベント詳細
+### 対象イベント
+- push: *
+  - tags
+    - semantic versioning tag (例：`v1.2.3`)
+    - [テストタグ](#test_tag_prefix) (例：`test/v1.2.3`)
+- push: rerequested
+
+## 動機
+`GitHub Action`をリリースするには、すべてのビルドファイルと `node_modules` のような依存関係が必要ですが、通常はそれらをコミットしません。  
+したがって`GitHub Action`リリースする際には以下のような手順が必要です。  
+1. ローカルの開発用ブランチで開発
+1. リリース用にビルド
+1. `node_modules` のような依存モジュールを含めて必要なソースをリリース用ブランチにコミット
+1. タグを付与 (メジャーバージョンやマイナーバージョンの考慮が必要)
+1. GitHub にプッシュ
+1. リリースを作成
+
+リリースの度にこれらの手順を実行するのはとても面倒です。  
+
+この `GitHub Action` を使用することで手順は単純になります。
+1. ローカルの開発用ブランチで開発
+1. リリースを作成 (タグを作成)
+1. 自動化された手順が完了するのを待つ
+   1. リリース用にビルド
+   1. `node_modules` のような依存モジュールを含めて必要なソースをリリース用ブランチにコミット
+   1. タグを付与 (メジャーバージョンやマイナーバージョンの考慮が必要)
+   1. GitHub にプッシュ
+
+## 補足
+### Tags
+タグ名は [Semantic Versioning](https://semver.org/) に従っている必要があります。  
+以下のタグが作成されます。
+- 指定されたタグ名
+- メジャーバージョンのタグ名 (指定されたタグ名から生成)
+  - 例：`v1`
+- マイナーバージョンのタグ名 (指定されたタグ名から生成)
+  - 例：`v1.2`
+
+## このアクションを使用しているアクションの例
+- [Release GitHub Actions](https://github.com/technote-space/release-github-actions)
+  - [released.yml](https://github.com/technote-space/release-github-actions/blob/master/.github/workflows/released.yml)
+- [Auto card labeler](https://github.com/technote-space/auto-card-labeler)
+  - [released.yml](https://github.com/technote-space/auto-card-labeler/blob/master/.github/workflows/released.yml)
+- [Assign Author](https://github.com/technote-space/assign-author)
+  - [released.yml](https://github.com/technote-space/assign-author/blob/master/.github/workflows/released.yml)
+- [TOC Generator](https://github.com/technote-space/toc-generator)
+  - [released.yml](https://github.com/technote-space/toc-generator/blob/master/.github/workflows/released.yml)
+
+## Author
+[GitHub (Technote)](https://github.com/technote-space)  
+[Blog](https://technote.space)

README.md

@@ -5,8 +5,10 @@
 [![CodeFactor](https://www.codefactor.io/repository/github/technote-space/release-github-actions/badge)](https://www.codefactor.io/repository/github/technote-space/release-github-actions)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/technote-space/release-github-actions/blob/master/LICENSE)
 
-This is a GitHub Action that automates the release of GitHub Action.  
-Once you publish the release, this action will automatically
+*Read this in other languages: [English](README.md), [日本語](README.ja.md).*
+
+This is a `GitHub Action` that automates the release of `GitHub Action`.  
+Once you create a new tag, this action will automatically
 1. Run build
 1. Create branch for release
 1. Change [tags](#tags) to release branch
@@ -37,8 +39,8 @@ Once you publish the release, this action will automatically
   - [Target events](#target-events)
 - [Motivation](#motivation)
 - [Addition](#addition)
-  - [tags](#tags)
-- [GitHub Actions using this Action](#github-actions-using-this-action)
+  - [Tags](#tags)
+- [Sample GitHub Actions using this Action](#sample-github-actions-using-this-action)
 - [Author](#author)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -48,9 +50,9 @@ Once you publish the release, this action will automatically
    ![Before publish release](https://raw.githubusercontent.com/technote-space/release-github-actions/images/screenshot-1.png)
 1. Publish release (Create tag)  
    ![Publish release](https://raw.githubusercontent.com/technote-space/release-github-actions/images/screenshot-2.png)
-1. Running GitHub Action  
+1. Running `GitHub Action`  
    ![Running GitHub Action](https://raw.githubusercontent.com/technote-space/release-github-actions/images/screenshot-3.png)
-1. After running GitHub Action  
+1. After running `GitHub Action`  
    ![After running GitHub Action](https://raw.githubusercontent.com/technote-space/release-github-actions/images/screenshot-4.png)
 
 ## Installation
@@ -109,7 +111,7 @@ Commit email.
 default: `'[email protected]'`
 
 ### BRANCH_NAME
-Branch name for GitHub Action release.  
+Branch name for `GitHub Action` release.  
 default: `'gh-actions'`
 
 ### CLEAN_TARGETS
@@ -118,15 +120,13 @@ default: `.[!.]*,__tests__,src,*.js,*.ts,*.json,*.lock,_config.yml`
 Absolute path and `..` are not permitted to use.
 
 ### CREATE_MAJOR_VERSION_TAG
-Whether to create major version tag.  
+Whether to create major version tag (e.g. v1).  
 default: `true`  
-Set to `false` if you do not want to create a major version tag.  
 [Detail of tags](#tags)
 
 ### CREATE_MINOR_VERSION_TAG
-Whether to create minor version tag.  
+Whether to create minor version tag (e.g. v1.2).  
 default: `true`  
-Set to `false` if you do not want to create a minor version tag.  
 [Detail of tags](#tags)
 
 ### OUTPUT_BUILD_INFO_FILENAME
@@ -170,11 +170,11 @@ e.g. `'original/'`
 - push: rerequested
 
 ## Motivation
-Release package needs all build files and dependencies like `node_modules`, but are not usually committed.  
+Releasing `GitHub Action` needs all build files and dependencies like `node_modules`, but are not usually committed.  
 So if you want to release `GitHub Action`, you have to do following steps.  
 1. Develop locally on the branch for develop
 1. Build for release
-1. Commit all source code including dependencies like `node_modules`
+1. Commit all source code including dependencies like `node_modules` to branch for release
 1. Add tags (consider major and minor versions)
 1. Push to GitHub
 1. Publish release
@@ -186,12 +186,12 @@ If you use this `GitHub Action`, the steps to do are simpler.
 1. Publish release (Create tag)
 1. Wait for the automated steps to finish
    1. Build for release
-   1. Commit all source code including dependencies like `node_modules`
+   1. Commit all source code including dependencies like `node_modules` to branch for release
    1. Add tags (consider major and minor versions)
    1. Push to GitHub
 
 ## Addition
-### tags 
+### Tags 
 Tag name format must be [Semantic Versioning](https://semver.org/).  
 The following tags will be created.
 - tag name
@@ -200,11 +200,15 @@ The following tags will be created.
 - minor tag name (generated by tag name)
   - e.g. `v1.2`
 
-## GitHub Actions using this Action
+## Sample GitHub Actions using this Action
 - [Release GitHub Actions](https://github.com/technote-space/release-github-actions)
+  - [released.yml](https://github.com/technote-space/release-github-actions/blob/master/.github/workflows/released.yml)
 - [Auto card labeler](https://github.com/technote-space/auto-card-labeler)
+  - [released.yml](https://github.com/technote-space/auto-card-labeler/blob/master/.github/workflows/released.yml)
 - [Assign Author](https://github.com/technote-space/assign-author)
+  - [released.yml](https://github.com/technote-space/assign-author/blob/master/.github/workflows/released.yml)
 - [TOC Generator](https://github.com/technote-space/toc-generator)
+  - [released.yml](https://github.com/technote-space/toc-generator/blob/master/.github/workflows/released.yml)
 
 ## Author
 [GitHub (Technote)](https://github.com/technote-space)  

build.json

@@ -1 +1 @@
-{"tagName":"v1.2.4","branch":"gh-actions","tags":["v1.2.4","v1","v1.2"],"updated_at":"2019-09-19T15:36:37.939Z"}
+{"tagName":"test/v1.3.0","branch":"gh-actions","tags":["test/v1.3.0","test/v1","test/v1.3"],"updated_at":"2019-09-20T15:59:11.936Z"}

lib/main.js

@@ -15,29 +15,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
 const core_1 = require("@actions/core");
 const github_1 = require("@actions/github");
-const signale_1 = __importDefault(require("signale"));
+const filter_github_action_1 = require("@technote-space/filter-github-action");
+const github_action_helper_1 = require("@technote-space/github-action-helper");
 const command_1 = require("./utils/command");
 const misc_1 = require("./utils/misc");
+const constant_1 = require("./constant");
+const { showActionInfo, getTagName } = github_action_helper_1.Utils;
 /**
  * run
  */
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const version = misc_1.getBuildVersion(path_1.default.resolve(__dirname, '..', 'build.json'));
-            const tagName = misc_1.getTagName(github_1.context);
-            if ('string' === typeof version) {
-                signale_1.default.info('Version: %s', version);
-            }
-            signale_1.default.info('Event: %s', github_1.context.eventName);
-            signale_1.default.info('Action: %s', github_1.context.payload.action);
-            signale_1.default.info('Tag name: %s', tagName);
-            if (!misc_1.isTargetEvent(github_1.context) || !misc_1.isValidTagName(tagName)) {
-                signale_1.default.complete('This is not target event.');
+            const logger = new github_action_helper_1.Logger();
+            const tagName = getTagName(github_1.context);
+            showActionInfo(path_1.default.resolve(__dirname, '..'), logger, github_1.context);
+            if (!filter_github_action_1.isTargetEvent(constant_1.TARGET_EVENTS, github_1.context) || !misc_1.isValidTagName(tagName)) {
+                logger.complete('This is not target event.');
                 return;
             }
             const directories = misc_1.getReplaceDirectory();
-            Object.keys(directories).forEach(directory => signale_1.default.info('%s: %s', directories[directory], directory));
+            Object.keys(directories).forEach(directory => logger.info('%s: %s', directories[directory], directory));
             yield command_1.deploy(new github_1.GitHub(core_1.getInput('GITHUB_TOKEN', { required: true })), github_1.context);
         }
         catch (error) {