node-package-release-action 0.1.8 → 1.0.3

package/README.md

@@ -16,21 +16,35 @@ name: Release
 on:
   schedule:
     - cron: "0 12 * * 0" # every sunday noon
-  workflow_dispatch:
 
 jobs:
-  accept_to_ship:
-    name: Accept to Ship
+  release:
+    name: Release
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
 
-      - uses: CatChen/node-package-release-action@v0.1
+      - id: release
+        uses: CatChen/node-package-release-action@v1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }} # optional
+          directory: "./" #optional
           release-type: prerelease # optional
-          prerelease: true # optional
+          prerelease: false # optional
+          update-shorthand-release: false
+          skip-if-no-diff: false
           dry-run: false # optional
+
+      - env:
+          TAG: ${{ steps.release.outputs.tag }}
+          SKIPPED: ${{ steps.release.outputs.skipped }}
+        run: |
+          if [[ "$SKIPPED"='true' ]]
+          then
+            echo 'Release is skipped.'
+          else
+            echo "Release $TAG successfully."
+          fi
 ```
 
 ## Options
@@ -55,6 +69,10 @@ This controls whether the GitHub Release should be marked as a prerelease. The d
 
 [GitHub Action documentation](https://docs.github.com/en/actions/creating-actions/about-custom-actions#using-tags-for-release-management) recommends updating shorthand releases like `v1` and `v1.2` when releasing the latest `v1.2.*`. Set this to `true` when using this Action to release other Actions. The default value is `false`.
 
+### `skip-if-no-diff`
+
+The controls whether this action should do nothing if there's no changes since last release of the same release type. If we release a minor upgrade to `1.2.3` or `1.2.3-4` it should be `1.2.4`. If `1.2.4` and `1.2.3` are the same and if `skip-if-no-diff` is set to `true`, `1.2.4` won't be created. `1.2.3-*` won't be used in the comparison. The default value is `false`.
+
 ### `dry-run`
 
 This controls whether this is a dry run. The default value is `false`. It's used for debugging only.
@@ -82,3 +100,59 @@ Let's start with the easy ones. `major`, `minor` and `patch` increase their corr
 - `2.3.4-5` + `preminor` => `2.4.0-0`
 - `2.3.4` + `prepatch` => `2.3.5-0`
 - `2.3.4-5` + `prepatch` => `2.3.5-0`
+
+### Can I create a Workflow to manually release with any release type I want at the time?
+
+<img width="359" alt="Screenshot 2022-11-14 at 5 35 13 PM" src="https://user-images.githubusercontent.com/112175/201804995-7cb572b4-87a6-4662-9e24-7c4d3b0ff844.png">
+
+Yes! You can provide inputs in the Action web interface before manually triggering a Workflow. [GitHub Action documentation](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#providing-inputs) describes how to do this. Below is an example.
+
+```yaml
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      release-type:
+        description: "Release Type"
+        required: true
+        default: "patch"
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+          - premajor
+          - preminor
+          - prepatch
+          - prerelease
+      prerelease:
+        description: "Prerelease"
+        required: true
+        default: false
+        type: boolean
+      dry-run:
+        description: "Dry run"
+        required: true
+        default: false
+        type: boolean
+
+  release:
+    name: Release
+    concurrency: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: "main"
+
+      - uses: CatChen/node-package-release-action@v1
+        with:
+          release-type: ${{ inputs.release-type || 'patch' }}
+          prerelease: ${{ inputs.prerelease || false }}
+          dry-run: ${{ inputs.dry-run || false }}
+```
+
+### How do I know if `skip-if-no-diff` took effect?
+
+Use an output called `skipped`. See the first code example as a reference.

package/lib/ReleaseType.d.ts

@@ -0,0 +1,2 @@
+export declare const RELEASE_TYPES: readonly ["major", "premajor", "minor", "preminor", "patch", "prepatch", "prerelease"];
+export type ReleaseType = typeof RELEASE_TYPES[number];

package/lib/ReleaseType.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RELEASE_TYPES = void 0;
+exports.RELEASE_TYPES = [
+    "major",
+    "premajor",
+    "minor",
+    "preminor",
+    "patch",
+    "prepatch",
+    "prerelease",
+];

package/lib/checkDiff.d.ts

@@ -0,0 +1 @@
+export declare function checkDiff(tag: string): Promise<boolean>;

package/lib/checkDiff.js

@@ -0,0 +1,30 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkDiff = void 0;
+const core_1 = require("@actions/core");
+const exec_1 = require("@actions/exec");
+function checkDiff(tag) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const diffOutput = yield (0, exec_1.getExecOutput)("git", ["diff", tag, "--name-only"]);
+        if (diffOutput.exitCode !== core_1.ExitCode.Success) {
+            throw new Error(diffOutput.stderr);
+        }
+        (0, core_1.debug)(`Diff against ${tag}:` +
+            "\n" +
+            diffOutput.stdout
+                .split("\n")
+                .map((line) => `  ${line}`)
+                .join("\n"));
+        return diffOutput.stdout.split("\n").join("") !== "";
+    });
+}
+exports.checkDiff = checkDiff;

package/lib/fetchEverything.js

@@ -29,7 +29,7 @@ function fetchEverything() {
         if (gitIsShallowRepositoryOutput.exitCode !== core_1.ExitCode.Success) {
             throw new Error(gitIsShallowRepositoryOutput.stderr);
         }
-        if (gitIsShallowRepositoryOutput.stdout === "true") {
+        if (gitIsShallowRepositoryOutput.stdout.trim() === "true") {
             const gitFetchUnshallowOutput = yield (0, exec_1.getExecOutput)("git", [
                 "fetch",
                 "--unshallow",

package/lib/findLastSameReleaseTypeVersion.d.ts

@@ -0,0 +1,2 @@
+import { ReleaseType } from "semver";
+export declare function findLastSameReleaseTypeVersion(releaseVersion: string, releaseType: ReleaseType): Promise<string | null>;

package/lib/findLastSameReleaseTypeVersion.js

@@ -0,0 +1,37 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findLastSameReleaseTypeVersion = void 0;
+const core_1 = require("@actions/core");
+const semver_1 = require("semver");
+const getAllGitTags_1 = require("./getAllGitTags");
+function findLastSameReleaseTypeVersion(releaseVersion, releaseType) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const versionTags = yield (0, getAllGitTags_1.getAllGitTags)();
+        if (versionTags.length === 0) {
+            (0, core_1.warning)(`No tag found.`);
+            return null;
+        }
+        const sortedTags = (0, semver_1.rsort)(versionTags);
+        let candidateTag = sortedTags.shift();
+        while (candidateTag !== undefined &&
+            ((0, semver_1.gte)(candidateTag, releaseVersion) ||
+                (0, semver_1.diff)(candidateTag, releaseVersion) !== releaseType)) {
+            candidateTag = sortedTags.shift();
+        }
+        if (candidateTag === undefined) {
+            (0, core_1.warning)(`No tag found.`);
+            return null;
+        }
+        return candidateTag;
+    });
+}
+exports.findLastSameReleaseTypeVersion = findLastSameReleaseTypeVersion;

package/lib/getAllGitTags.d.ts

@@ -0,0 +1 @@
+export declare function getAllGitTags(): Promise<string[]>;

package/lib/getAllGitTags.js

@@ -0,0 +1,27 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllGitTags = void 0;
+const core_1 = require("@actions/core");
+const exec_1 = require("@actions/exec");
+const semver_1 = require("semver");
+function getAllGitTags() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const tagOutput = yield (0, exec_1.getExecOutput)("git", ["tag"]);
+        if (tagOutput.exitCode !== core_1.ExitCode.Success) {
+            throw new Error(tagOutput.stderr);
+        }
+        const allTags = tagOutput.stdout.split("\n");
+        const versionTags = allTags.filter((tag) => (0, semver_1.valid)(tag));
+        return versionTags;
+    });
+}
+exports.getAllGitTags = getAllGitTags;

package/lib/getLastGitTag.js

@@ -11,21 +11,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLastGitTag = void 0;
 const core_1 = require("@actions/core");
-const exec_1 = require("@actions/exec");
 const semver_1 = require("semver");
+const getAllGitTags_1 = require("./getAllGitTags");
 function getLastGitTag() {
     return __awaiter(this, void 0, void 0, function* () {
-        const tagOutput = yield (0, exec_1.getExecOutput)("git", ["tag"]);
-        if (tagOutput.exitCode !== core_1.ExitCode.Success) {
-            throw new Error(tagOutput.stderr);
-        }
-        const allTags = tagOutput.stdout.split("\n");
-        const versionTags = allTags.filter((tag) => /v\d+\.\d+\.\d+(\-\d+)?/.test(tag));
-        const sortedTags = (0, semver_1.rsort)(versionTags);
-        if (sortedTags.length === 0) {
+        const versionTags = yield (0, getAllGitTags_1.getAllGitTags)();
+        if (versionTags.length === 0) {
             (0, core_1.warning)(`No tag found.`);
             return null;
         }
+        const sortedTags = (0, semver_1.rsort)(versionTags);
         const lastTag = sortedTags[0];
         return lastTag;
     });

package/lib/{getLatestRelease.d.ts → getlatestReleaseTag.d.ts}

@@ -1,3 +1,3 @@
 import type { Octokit } from "@octokit/core";
 import type { Api } from "@octokit/plugin-rest-endpoint-methods/dist-types/types";
-export declare function getLatestRelease(owner: string, repo: string, octokit: Octokit & Api): Promise<string | null>;
+export declare function getlatestReleaseTag(owner: string, repo: string, octokit: Octokit & Api): Promise<string | null>;

package/lib/{getLatestRelease.js → getlatestReleaseTag.js}

@@ -9,10 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLatestRelease = void 0;
+exports.getlatestReleaseTag = void 0;
 const core_1 = require("@actions/core");
 const request_error_1 = require("@octokit/request-error");
-function getLatestRelease(owner, repo, octokit) {
+const semver_1 = require("semver");
+function getlatestReleaseTag(owner, repo, octokit) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             const latestReleaseResponse = yield octokit.rest.repos.getLatestRelease({
@@ -21,27 +22,43 @@ function getLatestRelease(owner, repo, octokit) {
             });
             // Latest release doesn't include pre-release.
             const latestRelease = latestReleaseResponse.data;
-            return latestRelease.tag_name;
+            if ((0, semver_1.valid)(latestRelease.tag_name) !== null) {
+                return latestRelease.tag_name;
+            }
+            else {
+                (0, core_1.warning)(`Latest release tag is not a valid semver: ${latestRelease.tag_name}`);
+            }
         }
         catch (error) {
             if (error instanceof request_error_1.RequestError) {
                 if (error.status === 404) {
                     (0, core_1.warning)(`Latest release not found but pre-release may exist`);
-                    const releasesResponse = yield octokit.rest.repos.listReleases({
-                        owner,
-                        repo,
-                    });
-                    if (releasesResponse.data.length === 0) {
-                        // No release or pre-release available.
-                        (0, core_1.warning)(`Pre-release not found`);
-                        return null;
-                    }
-                    const latestRelease = releasesResponse.data[0];
-                    return latestRelease.tag_name;
+                }
+                else {
+                    throw new Error(`Unexpected status code: ${error.status}`);
                 }
             }
+            else {
+                throw error;
+            }
+        }
+        const releasesResponse = yield octokit.rest.repos.listReleases({
+            owner,
+            repo,
+        });
+        if (releasesResponse.data.length === 0) {
+            (0, core_1.warning)(`No release found`);
+            return null;
+        }
+        const releaseTags = releasesResponse.data.map((release) => release.tag_name);
+        const validReleaseTags = releaseTags.filter((tag) => (0, semver_1.valid)(tag) !== null);
+        if (validReleaseTags.length === 0) {
+            (0, core_1.warning)(`No valid release tag found`);
+            (0, core_1.debug)("Release tags:\n" + releaseTags.map((tag) => `  ${tag}`).join("\n"));
+            return null;
         }
-        return null;
+        const sortedReleaseTags = (0, semver_1.rsort)(validReleaseTags);
+        return sortedReleaseTags[0];
     });
 }
-exports.getLatestRelease = getLatestRelease;
+exports.getlatestReleaseTag = getlatestReleaseTag;

package/lib/index.js

@@ -12,25 +12,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@actions/core");
 const github_1 = require("@actions/github");
 const semver_1 = require("semver");
+const ReleaseType_1 = require("./ReleaseType");
 const getOctokit_1 = require("./getOctokit");
 const configGit_1 = require("./configGit");
 const fetchEverything_1 = require("./fetchEverything");
 const getLastGitTag_1 = require("./getLastGitTag");
 const getPackageVersion_1 = require("./getPackageVersion");
-const getLatestRelease_1 = require("./getLatestRelease");
+const getlatestReleaseTag_1 = require("./getlatestReleaseTag");
+const findLastSameReleaseTypeVersion_1 = require("./findLastSameReleaseTypeVersion");
 const setVersion_1 = require("./setVersion");
 const pushBranch_1 = require("./pushBranch");
 const createRelease_1 = require("./createRelease");
 const updateTags_1 = require("./updateTags");
-const RELEASE_TYPES = [
-    "major",
-    "premajor",
-    "minor",
-    "preminor",
-    "patch",
-    "prepatch",
-    "prerelease",
-];
+const checkDiff_1 = require("./checkDiff");
 const DEFAULT_VERSION = "0.1.0";
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
@@ -42,13 +36,13 @@ function run() {
         (0, core_1.notice)(`package.json version: ${packageVersion}`);
         const { owner, repo } = github_1.context.repo;
         const octokit = (0, getOctokit_1.getOctokit)();
-        const latestRelease = yield (0, getLatestRelease_1.getLatestRelease)(owner, repo, octokit);
-        (0, core_1.notice)(`Latest release: ${latestRelease}`);
-        const versions = [lastGitTag, packageVersion, latestRelease].flatMap((version) => (version === null ? [] : [version]));
+        const latestReleaseTag = yield (0, getlatestReleaseTag_1.getlatestReleaseTag)(owner, repo, octokit);
+        (0, core_1.notice)(`Latest release tag: ${latestReleaseTag}`);
+        const versions = [lastGitTag, packageVersion, latestReleaseTag].flatMap((version) => (version === null ? [] : [version]));
         const sortedVersions = (0, semver_1.rsort)(versions);
         const highestVersion = sortedVersions.length === 0 ? DEFAULT_VERSION : sortedVersions[0];
         (0, core_1.notice)(`Highest version: ${highestVersion}`);
-        const releaseType = RELEASE_TYPES.find((releaseType) => (0, core_1.getInput)("release-type").toLowerCase() === releaseType);
+        const releaseType = ReleaseType_1.RELEASE_TYPES.find((releaseType) => (0, core_1.getInput)("release-type").toLowerCase() === releaseType);
         if (releaseType === undefined) {
             (0, core_1.setFailed)(`Invalid release-type input: ${(0, core_1.getInput)("release-type")}`);
             return;
@@ -59,6 +53,20 @@ function run() {
             return;
         }
         (0, core_1.notice)(`Release version: ${releaseVersion}`);
+        if ((0, core_1.getBooleanInput)("skip-if-no-diff")) {
+            const lastSameReleaseTypeVersion = yield (0, findLastSameReleaseTypeVersion_1.findLastSameReleaseTypeVersion)(releaseVersion, releaseType);
+            (0, core_1.notice)(`Last same release type version: ${lastSameReleaseTypeVersion}`);
+            if (lastSameReleaseTypeVersion !== null) {
+                const diff = yield (0, checkDiff_1.checkDiff)(lastSameReleaseTypeVersion);
+                if (!diff) {
+                    (0, core_1.notice)(`Skip due to lack of diff between HEAD..${lastSameReleaseTypeVersion}`);
+                    (0, core_1.setOutput)("skipped", true);
+                    return;
+                }
+            }
+            (0, core_1.setOutput)("skipped", false);
+        }
+        (0, core_1.setOutput)("tag", `v${releaseVersion}`);
         yield (0, setVersion_1.setVersion)(releaseVersion);
         yield (0, pushBranch_1.pushBranch)();
         yield (0, createRelease_1.createRelease)(owner, repo, releaseVersion, octokit);

package/lib/updateTags.js

@@ -21,8 +21,8 @@ function updateTags(version) {
             throw new Error(`Failed to parse the version as semver: ${version}`);
         }
         if (semver.prerelease.length !== 0) {
-            (0, core_1.warning)(`Pre-release version should not be used to update shorthand tags: ${version}`);
-            (0, core_1.warning)("Please don't set release-type to prerelease and update-shorthand-release to true at the same time");
+            (0, core_1.warning)(`Pre-release version should not be used to update shorthand tags: ${version}` +
+                "\nPlease don't set release-type to prerelease and update-shorthand-release to true at the same time");
         }
         if (semver.major > 0) {
             const gitTagMajorOutput = yield (0, exec_1.getExecOutput)("git", [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-package-release-action",
-  "version": "0.1.8",
+  "version": "1.0.3",
   "description": "A template to create custom GitHub Action with TypeScript/JavaScript.",
   "main": "lib/index.js",
   "types": "lib/index.d.js",
@@ -14,14 +14,14 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/CatChen/typescript-github-action-template.git"
+    "url": "git+https://github.com/CatChen/node-package-release-action.git"
   },
   "author": "Cat Chen",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/CatChen/typescript-github-action-template/issues"
+    "url": "https://github.com/CatChen/node-package-release-action/issues"
   },
-  "homepage": "https://github.com/CatChen/typescript-github-action-template#readme",
+  "homepage": "https://github.com/CatChen/node-package-release-action#readme",
   "devDependencies": {
     "@octokit/graphql-schema": "^12.24.0",
     "@octokit/webhooks-definitions": "^3.67.3",