feat: Build for release

Author: technote-space

README.md

@@ -1,72 +1,89 @@
-# 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)
-
-GitHub actions to auto release.  
-Once you publish the release, this action will automatically
-1. Run build
-1. Create branch for release
-1. Change tag to release branch
-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. 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
-- Tag name
-
-## Options
-### BUILD_COMMAND
-Build command.  
-default: `''`  
-- If package.json includes build or production or prod in scripts, the command is used for build.  
-- If command does not have install command like `npm run install` or `yarn install`, install commands are added.  
-- If command is not provided, `rm -rdf .github` command is added.
-
-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 .github
-```
-
-### COMMIT_MESSAGE
-Commit message.  
-default: `'feat: Build for release'`
-
-### COMMIT_NAME
-Commit name.  
-default: `'GitHub Actions'`
-
-### COMMIT_EMAIL
-Commit email.  
-default: `'[email protected]'`
+# 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)
+
+GitHub actions to auto release.  
+Once you publish the release, this action will automatically
+1. Run build
+1. Create branch for release
+1. Change [tags](#tags) to release branch
+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. 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
+- Tag name
+
+## Options
+### BUILD_COMMAND
+Build command.  
+default: `''`  
+- If package.json includes build or production or prod in scripts, the command is used for build.  
+- 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 .github
+...
+rm -rdf *.lock
+```
+
+### COMMIT_MESSAGE
+Commit message.  
+default: `'feat: Build for release'`
+
+### COMMIT_NAME
+Commit name.  
+default: `'GitHub Actions'`
+
+### COMMIT_EMAIL
+Commit email.  
+default: `'[email protected]'`
+
+### CLEAN_TARGETS
+Files or directories to delete before release (Comma separated).  
+default: `.github,__tests__,src,.gitignore,*.js,*.json,*.lock`  
+Absolute path and `..` are not permitted to use.
+
+## Addition
+### tags 
+Tag name format must be [Semantic Versioning](https://semver.org/).  
+The following tags will be created or attached to latest release.
+- tag name
+- major tag name (generated by tag name)
+  - e.g. `v1`
+- minor tag name (generated by tag name)
+  - e.g. `v1.2`

__tests__/utils/misc.test.ts

@@ -12,8 +12,13 @@ import {
     getGitUrl,
     detectBuildCommand,
     getRepository,
+    isValidTagName,
+    getMajorTag,
+    getMinorTag,
+    uniqueArray,
 } from '../../src/utils/misc';
 import {DEFAULT_COMMIT_MESSAGE, DEFAULT_COMMIT_NAME, DEFAULT_COMMIT_EMAIL, DEFAULT_BRANCH_NAME} from '../../src/constant';
+import {describe} from 'jest-circus';
 
 const testEnv = () => {
     const OLD_ENV = process.env;
@@ -193,6 +198,12 @@ describe('getBuildCommands', () => {
             'yarn build', // build command of package.json
             'yarn install --production',
             'rm -rdf .github',
+            'rm -rdf __tests__',
+            'rm -rdf src',
+            'rm -rdf .gitignore',
+            'rm -rdf *.js',
+            'rm -rdf *.json',
+            'rm -rdf *.lock',
         ]);
     });
 
@@ -226,6 +237,20 @@ describe('getBuildCommands', () => {
         expect(getBuildCommands(path.resolve(__dirname, '..', 'fixtures', 'test1'))).toEqual([
             'yarn install --production',
             'rm -rdf .github',
+            'rm -rdf __tests__',
+            'rm -rdf src',
+            'rm -rdf .gitignore',
+            'rm -rdf *.js',
+            'rm -rdf *.json',
+            'rm -rdf *.lock',
+        ]);
+    });
+
+    it('should get build commands 7', () => {
+        process.env.INPUT_CLEAN_TARGETS = 'test';
+        expect(getBuildCommands(path.resolve(__dirname, '..', 'fixtures', 'test1'))).toEqual([
+            'yarn install --production',
+            'rm -rdf test',
         ]);
     });
 });
@@ -306,3 +331,49 @@ describe('getRepository', () => {
         })).toBe('Hello/World');
     });
 });
+
+describe('isValidTagName', () => {
+    it('should return true', () => {
+        expect(isValidTagName('0')).toBeTruthy();
+        expect(isValidTagName('v12')).toBeTruthy();
+        expect(isValidTagName('1.2')).toBeTruthy();
+        expect(isValidTagName('V1.2.3')).toBeTruthy();
+        expect(isValidTagName('v12.23.34.45')).toBeTruthy();
+    });
+
+    it('should return false', () => {
+        expect(isValidTagName('')).toBeFalsy();
+        expect(isValidTagName('abc')).toBeFalsy();
+        expect(isValidTagName('v1.')).toBeFalsy();
+        expect(isValidTagName('v.9')).toBeFalsy();
+    });
+});
+
+describe('getMajorTag', () => {
+    it('should get major tag', () => {
+        expect(getMajorTag('0')).toBe('v0');
+        expect(getMajorTag('v12')).toBe('v12');
+        expect(getMajorTag('1.2')).toBe('v1');
+        expect(getMajorTag('V1.2.3')).toBe('v1');
+        expect(getMajorTag('v12.23.34.45')).toBe('v12');
+    });
+});
+
+describe('getMinorTag', () => {
+    it('should get minor tag', () => {
+        expect(getMinorTag('0')).toBe('v0.0');
+        expect(getMinorTag('v12')).toBe('v12.0');
+        expect(getMinorTag('1.2')).toBe('v1.2');
+        expect(getMinorTag('V1.2.3')).toBe('v1.2');
+        expect(getMinorTag('v12.23.34.45')).toBe('v12.23');
+    });
+});
+
+describe('uniqueArray', () => {
+    it('should return unique array', () => {
+        expect(uniqueArray([])).toEqual([]);
+        expect(uniqueArray<number>([1, 2, 2, 3, 4, 3])).toEqual([1, 2, 3, 4]);
+        expect(uniqueArray<string>(['1', '2', '2', '3', '4', '3'])).toEqual(['1', '2', '3', '4']);
+        expect(uniqueArray<string>(['v1.2', 'v1', 'v1.2'])).toEqual(['v1.2', 'v1']);
+    });
+});

action.yml

@@ -23,6 +23,9 @@ inputs:
   BRANCH_NAME:
     description: Branch name.
     default: 'gh-actions'
+  CLEAN_TARGETS:
+    description: Files or directories to delete before release. (Comma separated)
+    default: '.github,__tests__,src,.gitignore,*.js,*.json,*.lock'
 runs:
   using: node12
   main: lib/main.js

lib/constant.js

@@ -4,6 +4,7 @@ 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.TARGET_EVENT_NAME = 'release';
 exports.TARGET_EVENT_ACTION = 'published';
 exports.SEARCH_BUILD_COMMAND_TARGETS = [

lib/main.js

@@ -26,6 +26,10 @@ function run() {
                 return;
             }
             signale_1.default.info(`Tag name: ${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;
+            }
             yield command_1.deploy(github_1.context.payload.release.tag_name, new github_1.GitHub(core_1.getInput('GITHUB_TOKEN', { required: true })), github_1.context);
         }
         catch (error) {

lib/utils/command.js

@@ -95,10 +95,15 @@ const commit = (pushDir) => __awaiter(this, void 0, void 0, function* () {
 const push = (pushDir, tagName, branchName, context) => __awaiter(this, void 0, void 0, function* () {
     signale_1.default.info('Pushing to %s@%s (tag: %s)', misc_1.getRepository(context), branchName, tagName);
     const url = misc_1.getGitUrl(context);
-    yield execAsync(`git -C ${pushDir} push --delete "${url}" tag ${tagName}`, true, 'git push --delete origin tag');
+    const tagNames = misc_1.uniqueArray([tagName, misc_1.getMajorTag(tagName), misc_1.getMinorTag(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} tag -l | xargs git -C ${pushDir} tag -d`);
     yield execAsync(`git -C ${pushDir} fetch "${url}" --tags`, true, 'git fetch origin --tags');
-    yield execAsync(`git -C ${pushDir} tag ${tagName}`);
+    for (const tagName of tagNames) {
+        yield execAsync(`git -C ${pushDir} tag ${tagName}`);
+    }
     yield execAsync(`git -C ${pushDir} push --quiet --tags "${url}" "${branchName}":"refs/heads/${branchName}"`, true, `git push --tags "${branchName}":"refs/heads/${branchName}"`);
     return true;
 });

lib/utils/misc.js

@@ -31,7 +31,7 @@ exports.getBuildCommands = (dir) => {
         commands.push('yarn install --production');
     }
     if ('' === command) {
-        commands.push('rm -rdf .github');
+        commands.push(...getCleanTargets().map(target => `rm -rdf ${target}`));
     }
     return commands;
 };
@@ -57,4 +57,10 @@ exports.detectBuildCommand = (dir) => {
     }
     return false;
 };
+exports.uniqueArray = (array) => [...new Set(array)];
+exports.isValidTagName = (tagName) => /^v?\d+(\.\d+)*$/i.test(tagName);
+exports.getMajorTag = (tagName) => 'v' + getVersionFragments(tagName).slice(0, 1).join('.');
+exports.getMinorTag = (tagName) => 'v' + getVersionFragments(tagName).concat(['0']).slice(0, 2).join('.');
+const getVersionFragments = (tagName) => tagName.trim().replace(/^v?/gi, '').split('.');
 const normalizeCommand = (command) => command.trim().replace(/\s{2,}/g, ' ');
+const getCleanTargets = () => [...new Set((core_1.getInput('CLEAN_TARGETS') || constant_1.DEFAULT_CLEAN_TARGETS).split(',').map(target => target.trim()).filter(target => target && !target.startsWith('/') && !target.includes('..')))];

src/constant.ts

@@ -2,6 +2,7 @@ export const DEFAULT_COMMIT_MESSAGE = 'feat: Build for release';
 export const DEFAULT_COMMIT_NAME = 'GitHub Actions';
 export const DEFAULT_COMMIT_EMAIL = '[email protected]';
 export const DEFAULT_BRANCH_NAME = 'gh-actions';
+export const DEFAULT_CLEAN_TARGETS = '.github,__tests__,src,.gitignore,*.js,*.json,*.lock';
 export const TARGET_EVENT_NAME = 'release';
 export const TARGET_EVENT_ACTION = 'published';
 export const SEARCH_BUILD_COMMAND_TARGETS = [

src/main.ts

@@ -2,7 +2,7 @@ import {setFailed, getInput} from '@actions/core';
 import {context, GitHub} from '@actions/github';
 import signale from 'signale';
 import {deploy} from './utils/command';
-import {isTargetEvent} from './utils/misc';
+import {isTargetEvent, isValidTagName} from './utils/misc';
 
 async function run() {
     try {
@@ -14,6 +14,11 @@ async function run() {
         }
 
         signale.info(`Tag name: ${context.payload.release.tag_name}`);
+        if (!isValidTagName(context.payload.release.tag_name)) {
+            signale.info('This tag name is invalid.');
+            return;
+        }
+
         await deploy(context.payload.release.tag_name, new GitHub(getInput('GITHUB_TOKEN', {required: true})), context);
     } catch (error) {
         setFailed(error.message);

src/utils/command.ts

@@ -4,7 +4,19 @@ import signale from 'signale';
 import {exec} from 'child_process';
 import {GitHub} from '@actions/github/lib/github';
 import {Context} from '@actions/github/lib/context';
-import {getGitUrl, getRepository, getBuildCommands, getWorkspace, getCommitMessage, getCommitName, getCommitEmail, getBranchName} from './misc';
+import {
+    getGitUrl,
+    getRepository,
+    getBuildCommands,
+    getWorkspace,
+    getCommitMessage,
+    getCommitName,
+    getCommitEmail,
+    getBranchName,
+    getMajorTag,
+    getMinorTag,
+    uniqueArray,
+} from './misc';
 
 export const deploy = async (tagName: string, octokit: GitHub, context: Context) => {
     const workDir = path.resolve(getWorkspace(), '.work');
@@ -96,10 +108,15 @@ const push = async (pushDir: string, tagName: string, branchName: string, contex
     signale.info('Pushing to %s@%s (tag: %s)', getRepository(context), branchName, tagName);
 
     const url = getGitUrl(context);
-    await execAsync(`git -C ${pushDir} push --delete "${url}" tag ${tagName}`, true, 'git push --delete origin tag');
+    const tagNames = uniqueArray([tagName, getMajorTag(tagName), getMinorTag(tagName)]);
+    for (const tagName of tagNames) {
+        await execAsync(`git -C ${pushDir} push --delete "${url}" tag ${tagName}`, true, 'git push --delete origin tag', true);
+    }
     await execAsync(`git -C ${pushDir} tag -l | xargs git -C ${pushDir} tag -d`);
     await execAsync(`git -C ${pushDir} fetch "${url}" --tags`, true, 'git fetch origin --tags');
-    await execAsync(`git -C ${pushDir} tag ${tagName}`);
+    for (const tagName of tagNames) {
+        await execAsync(`git -C ${pushDir} tag ${tagName}`);
+    }
     await execAsync(`git -C ${pushDir} push --quiet --tags "${url}" "${branchName}":"refs/heads/${branchName}"`, true, `git push --tags "${branchName}":"refs/heads/${branchName}"`);
     return true;
 };