feat: Build for release

Author: technote-space

README.md

@@ -13,35 +13,29 @@ Once you publish the release, this action will automatically
 1. Change release tag
 
 ## Installation
-.github/workflows/release.yml
-```yaml
-on: release
-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. Setup workflow  
+   e.g. `.github/workflows/release.yml`
+   ```yaml
+   on: release
+   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 }}
+   ```
+
+### Required parameter
+#### ACCESS_TOKEN
 1. Generate a [personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) with the public_repo or repo scope.
 (repo is required for private repositories).  
 1. [Save as secrets](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables)
 
-## Details
-### Target event
-- release
-### Target action
-- published
-### Branch name
-- [BRANCH_NAME](#branch_name)
-
 ## Options
 ### BUILD_COMMAND
 Build command.  
@@ -79,7 +73,7 @@ default: `'gh-actions'`
 
 ### CLEAN_TARGETS
 Files or directories to delete before release (Comma separated).  
-default: `.github,__tests__,src,.gitignore,*.js,*.json,*.lock`  
+default: `.github,__tests__,src,.gitignore,*.js,*.json,*.lock,_config.yml`  
 Absolute path and `..` are not permitted to use.
 
 ### CREATE_MAJOR_VERSION_TAG
@@ -94,6 +88,50 @@ default: `true`
 Set to `false` if you do not want to create a minor version tag.  
 [Detail of tags](#tags)
 
+### OUTPUT_BUILD_INFO_FILENAME
+Filename of build information.
+default: `''`  
+Absolute path and `..` are not permitted to use.  
+If this setting is not empty, following information is output with the file name.
+```json
+{
+  "tagName": "${tagName}",
+  "branch": "${branch}",
+  "tags": [
+    "${created_tag_1}",
+    "${created_tag_n}"
+  ],
+  "updated_at": "${updated_at}"
+}
+```
+
+## Action event details
+### Target event
+- release
+### Target action
+- published
+
+## Motivation
+Release package needs all dependencies like `node_modules`, but usually they are not committed.  
+So if you want to release `GitHub Actions`, 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. Add tags (consider major and minor versions)
+1. Push to GitHub
+1. Publish release
+
+It is very troublesome to do this steps for every release.  
+
+If you use this `GitHub Action`, the steps to do are simple.
+1. Develop locally on the branch for develop
+1. Publish release
+1. Wait for the automated steps to finish
+   1. Build for release
+   1. Commit all source code including dependencies like `node_modules`
+   1. Add tags (consider major and minor versions)
+   1. Push to GitHub
+
 ## Addition
 ### tags 
 Tag name format must be [Semantic Versioning](https://semver.org/).  

action.yml

@@ -25,13 +25,16 @@ inputs:
     default: 'gh-actions'
   CLEAN_TARGETS:
     description: Files or directories to delete before release. (Comma separated)
-    default: '.github,__tests__,src,.gitignore,*.js,*.json,*.lock'
+    default: '.github,__tests__,src,.gitignore,*.js,*.json,*.lock,_config.yml'
   CREATE_MAJOR_VERSION_TAG:
     description: Whether to create major version tag.
     default: true
   CREATE_MINOR_VERSION_TAG:
     description: Whether to create minor version tag.
     default: true
+  OUTPUT_BUILD_INFO_FILENAME:
+    description: Filename of build information.
+    default: ''
 branding:
   icon: 'tag'
   color: 'green'

lib/constant.js

@@ -4,7 +4,8 @@ exports.DEFAULT_COMMIT_MESSAGE = 'feat: Build for release';
 exports.DEFAULT_COMMIT_NAME = 'GitHub Actions';
 exports.DEFAULT_COMMIT_EMAIL = '[email protected]';
 exports.DEFAULT_BRANCH_NAME = 'gh-actions';
-exports.DEFAULT_CLEAN_TARGETS = '.github,__tests__,src,.gitignore,*.js,*.json,*.lock';
+exports.DEFAULT_CLEAN_TARGETS = '.github,__tests__,src,.gitignore,*.js,*.json,*.lock,_config.yml';
+exports.DEFAULT_OUTPUT_BUILD_INFO_FILENAME = '';
 exports.TARGET_EVENT_NAME = 'release';
 exports.TARGET_EVENT_ACTION = 'published';
 exports.SEARCH_BUILD_COMMAND_TARGETS = [

lib/main.js

@@ -11,6 +11,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 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"));
@@ -19,13 +20,17 @@ const misc_1 = require("./utils/misc");
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            signale_1.default.info(`Event: ${github_1.context.eventName}`);
-            signale_1.default.info(`Action: ${github_1.context.action}`);
+            const version = misc_1.getBuildVersion(path_1.default.resolve(__dirname, '..', 'build.json'));
+            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.action);
             if (!misc_1.isTargetEvent(github_1.context)) {
                 signale_1.default.info('This is not target event.');
                 return;
             }
-            signale_1.default.info(`Tag name: ${github_1.context.payload.release.tag_name}`);
+            signale_1.default.info('Tag name: %s', github_1.context.payload.release.tag_name);
             if (!misc_1.isValidTagName(github_1.context.payload.release.tag_name)) {
                 signale_1.default.info('This tag name is invalid.');
                 return;

lib/utils/command.js

@@ -14,6 +14,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const signale_1 = __importDefault(require("signale"));
+const moment_1 = __importDefault(require("moment"));
 const child_process_1 = require("child_process");
 const misc_1 = require("./misc");
 exports.deploy = (tagName, octokit, context) => __awaiter(this, void 0, void 0, function* () {
@@ -25,7 +26,9 @@ exports.deploy = (tagName, octokit, context) => __awaiter(this, void 0, void 0,
     fs_1.default.mkdirSync(pushDir, { recursive: true });
     if (!(yield cloneForBranch(pushDir, branchName, context)))
         return;
-    if (!(yield exports.prepareFiles(buildDir, pushDir, context)))
+    if (!(yield exports.prepareFiles(buildDir, pushDir, tagName, context)))
+        return;
+    if (!(yield createBuildInfoFile(buildDir, tagName, branchName)))
         return;
     if (!(yield copyFiles(buildDir, pushDir)))
         return;
@@ -37,13 +40,31 @@ exports.deploy = (tagName, octokit, context) => __awaiter(this, void 0, void 0,
         return;
     yield updateRelease(tagName, octokit, context);
 });
-exports.prepareFiles = (buildDir, pushDir, context) => __awaiter(this, void 0, void 0, function* () {
+exports.prepareFiles = (buildDir, pushDir, tagName, context) => __awaiter(this, void 0, void 0, function* () {
     signale_1.default.info('Preparing files for release');
     fs_1.default.mkdirSync(buildDir, { recursive: true });
     yield cloneForBuild(buildDir, context);
     yield runBuild(buildDir);
     return true;
 });
+const createBuildInfoFile = (buildDir, tagName, branchName) => __awaiter(this, void 0, void 0, function* () {
+    const filename = misc_1.getOutputBuildInfoFilename();
+    if (!filename)
+        return true;
+    signale_1.default.info('Creating build info file');
+    const filepath = path_1.default.resolve(buildDir, filename);
+    const dir = path_1.default.dirname(filepath);
+    if (!fs_1.default.existsSync(dir)) {
+        fs_1.default.mkdirSync(dir, { recursive: true });
+    }
+    fs_1.default.writeFileSync(filepath, JSON.stringify({
+        'version': tagName,
+        'branch': branchName,
+        'tags': misc_1.getCreateTags(tagName),
+        'updated_at': moment_1.default().toISOString(),
+    }));
+    return true;
+});
 const cloneForBranch = (pushDir, branchName, context) => __awaiter(this, void 0, void 0, function* () {
     signale_1.default.info('Cloning the branch %s from the remote repo', branchName);
     const url = misc_1.getGitUrl(context);
@@ -97,7 +118,7 @@ const push = (pushDir, tagName, branchName, context) => __awaiter(this, void 0,
     const url = misc_1.getGitUrl(context);
     const tagNames = misc_1.getCreateTags(tagName);
     for (const tagName of tagNames) {
-        yield execAsync(`git -C ${pushDir} push --delete "${url}" tag ${tagName}`, true, 'git push --delete origin tag', true);
+        yield execAsync(`git -C ${pushDir} push --delete "${url}" tag ${tagName}`, true, `git push --delete origin tag ${tagName}`, true);
     }
     yield execAsync(`git -C ${pushDir} tag -l | xargs git -C ${pushDir} tag -d`);
     yield execAsync(`git -C ${pushDir} fetch "${url}" --tags`, true, 'git fetch origin --tags');

lib/utils/misc.js

@@ -42,6 +42,22 @@ exports.getCommitEmail = () => core_1.getInput('COMMIT_EMAIL') || constant_1.DEF
 exports.getBranchName = () => core_1.getInput('BRANCH_NAME') || constant_1.DEFAULT_BRANCH_NAME;
 exports.isCreateMajorVersionTag = () => getBoolValue(core_1.getInput('CREATE_MAJOR_VERSION_TAG') || 'true');
 exports.isCreateMinorVersionTag = () => getBoolValue(core_1.getInput('CREATE_MINOR_VERSION_TAG') || 'true');
+exports.getOutputBuildInfoFilename = () => {
+    const filename = (core_1.getInput('OUTPUT_BUILD_INFO_FILENAME') || constant_1.DEFAULT_OUTPUT_BUILD_INFO_FILENAME).trim();
+    if (filename.startsWith('/') || filename.includes('..'))
+        return '';
+    return filename;
+};
+exports.getBuildVersion = (filepath) => {
+    if (!fs_1.default.existsSync(filepath)) {
+        return false;
+    }
+    const json = JSON.parse(fs_1.default.readFileSync(filepath, 'utf8'));
+    if (json && 'tagName' in json) {
+        return json['tagName'];
+    }
+    return false;
+};
 exports.getCreateTags = (tagName) => {
     const tagNames = [tagName];
     if (exports.isCreateMajorVersionTag()) {