Support custom target_commitish value (#76)

* Make target_commitish configurable

* Store compiled action for testing

* Add target_commitish to metadata

* Allow override of target_commitish for updating

* Print commit usage

* Improve message for commit usage

* Update draft releases too

* Revert "Update draft releases too"

This reverts commit ff30f8edb1.

* Integrate latest changes from upstream.

README.md

@@ -173,16 +173,17 @@ jobs:
 
 The following are optional as `step.with` keys
 
-| Name                      | Type    | Description                                                           |
-|---------------------------|---------|-----------------------------------------------------------------------|
-| `body`                    | String  | Text communicating notable changes in this release                    |
-| `body_path`               | String  | Path to load text communicating notable changes in this release       |
-| `draft`                   | Boolean | Indicator of whether or not this release is a draft                   |
-| `prerelease`              | Boolean | Indicator of whether or not is a prerelease                           |
-| `files`                   | String  | Newline-delimited globs of paths to assets to upload for release      |
-| `name`                    | String  | Name of the release. defaults to tag name                             |
-| `tag_name`                | String  | Name of a tag. defaults to `github.ref`                               |
-| `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing|
+| Name                      | Type    | Description                                                                                         |
+|---------------------------|---------|-----------------------------------------------------------------------------------------------------|
+| `body`                    | String  | Text communicating notable changes in this release                                                  |
+| `body_path`               | String  | Path to load text communicating notable changes in this release                                     |
+| `draft`                   | Boolean | Indicator of whether or not this release is a draft                                                 |
+| `prerelease`              | Boolean | Indicator of whether or not is a prerelease                                                         |
+| `files`                   | String  | Newline-delimited globs of paths to assets to upload for release                                    |
+| `name`                    | String  | Name of the release. defaults to tag name                                                           |
+| `tag_name`                | String  | Name of a tag. defaults to `github.ref`                                                             |
+| `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing                              |
+| `target_commitish`        | String  | Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. |
 
 💡When providing a `body` and `body_path` at the same time, `body_path` will be attempted first, then falling back on `body` if the path can not be read from.
 

__tests__/util.test.ts

@@ -37,7 +37,8 @@ describe("util", () => {
           input_prerelease: false,
           input_files: [],
           input_name: undefined,
-          input_tag_name: undefined
+          input_tag_name: undefined,
+          input_target_commitish: undefined
         })
       );
     });
@@ -54,7 +55,8 @@ describe("util", () => {
           input_prerelease: false,
           input_files: [],
           input_name: undefined,
-          input_tag_name: undefined
+          input_tag_name: undefined,
+          input_target_commitish: undefined
         })
       );
     });
@@ -71,7 +73,8 @@ describe("util", () => {
           input_prerelease: false,
           input_files: [],
           input_name: undefined,
-          input_tag_name: undefined
+          input_tag_name: undefined,
+          input_target_commitish: undefined
         })
       );
     });
@@ -89,10 +92,34 @@ describe("util", () => {
         input_files: [],
         input_name: undefined,
         input_tag_name: undefined,
-        input_fail_on_unmatched_files: false
+        input_fail_on_unmatched_files: false,
+        input_target_commitish: undefined
       });
     });
   });
+  describe("parseConfig", () => {
+    it("parses basic config with commitish", () => {
+      assert.deepStrictEqual(
+        parseConfig({
+          INPUT_TARGET_COMMITISH: "affa18ef97bc9db20076945705aba8c516139abd"
+        }),
+        {
+          github_ref: "",
+          github_repository: "",
+          github_token: "",
+          input_body: undefined,
+          input_body_path: undefined,
+          input_draft: false,
+          input_prerelease: false,
+          input_files: [],
+          input_name: undefined,
+          input_tag_name: undefined,
+          input_fail_on_unmatched_files: false,
+          input_target_commitish: "affa18ef97bc9db20076945705aba8c516139abd"
+        }
+      );
+    });
+  });
   describe("isTag", () => {
     it("returns true for tags", async () => {
       assert.equal(isTag("refs/tags/foo"), true);

action.yml

@@ -30,6 +30,9 @@ inputs:
   repository:
     description: 'Repository to make releases against, in <owner>/<repo> format'
     required: false
+  target_commitish:
+    description: 'Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA.'
+    required: false
 env:
   'GITHUB_TOKEN': 'As provided by Github Actions'
 outputs:

dist/index.js

@@ -1 +1 @@
-module.exports=function(e,t){"use strict";var r={};function __webpack_require__(t){if(r[t]){return r[t].exports}var i=r[t]={i:t,l:false,exports:{}};e[t].call(i.exports,i,i.exports,__webpack_require__);i.l=true;return i.exports}__webpack_require__.ab=__dirname+"/";function startup(){return __webpack_require__(131)}return startup()}({0:function(e,t,r){const{requestLog:i}=r(916);const{restEndpointMethods:n}=r(842);const s=r(529);const o=[r(190),r(19),i,r(148),n,r(430),r(850)];const a=s.plugin(o);function DeprecatedOctokit(e){const t=e&&e.log&&e.log.warn?e.log.warn:console.warn;t('[@octokit/rest] `const Octokit = require("@octokit/rest")` is deprecated. Use `const { Octokit } = require("@octokit/rest")` instead');return new a(e)}const p=Object.assign(DeprecatedOctokit,{Octokit:a});Object.keys(a).forEach(e=>{if(a.hasOwnProperty(e)){p[e]=a[e]}});e.exports=p},2:function(e,t,r){"use strict";const i=r(87);const n=r(118);const s=r(494);const o=(e,t)=>{if(!e&&t){throw new Error("You can't specify a `release` without specifying `platform`")}e=e||i.platform();let r;if(e==="darwin"){if(!t&&i.platform()==="darwin"){t=i.release()}const e=t?Number(t.split(".")[0])>15?"macOS":"OS X":"macOS";r=t?n(t).name:"";return e+(r?" "+r:"")}if(e==="linux"){if(!t&&i.platform()==="linux"){t=i.release()}r=t?t.replace(/^(\d+\.\d+).*/,"$1"):"";return"Linux"+(r?" "+r:"")}if(e==="win32"){if(!t&&i.platform()==="win32"){t=i.release()}r=t?s(t):"";return"Windows"+(r?" "+r:"")}return e};e.exports=o},3:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:true});function isObject(e){return Object.prototype.toString.call(e)==="[object Object]"}function isPlainObject(e){var t,r;if(isObject(e)===false)return false;t=e.constructor;if(t===undefined)return true;r=t.prototype;if(isObject(r)===false)return false;if(r.hasOwnProperty("isPrototypeOf")===false){return false}return true}t.isPlainObject=isPlainObject},4:function(e,t){"use strict";var r="\ufeff";t.PrependBOM=PrependBOMWrapper;function PrependBOMWrapper(e,t){this.encoder=e;this.addBOM=true}PrependBOMWrapper.prototype.write=function(e){if(this.addBOM){e=r+e;this.addBOM=false}return this.encoder.write(e)};PrependBOMWrapper.prototype.end=function(){return this.encoder.end()};t.StripBOM=StripBOMWrapper;function StripBOMWrapper(e,t){this.decoder=e;this.pass=false;this.options=t||{}}StripBOMWrapper.prototype.write=function(e){var t=this.decoder.write(e);if(this.pass||!t)return t;if(t[0]===r){t=t.slice(1);if(typeof this.options.stripBOM==="function")this.options.stripBOM()}this.pass=true;return t};StripBOMWrapper.prototype.end=function(){return this.decoder.end()}},9:function(e,t,r){var i=r(49);var n=function(){};var s=function(e){return e.setHeader&&typeof e.abort==="function"};var o=function(e){return e.stdio&&Array.isArray(e.stdio)&&e.stdio.length===3};var a=function(e,t,r){if(typeof t==="function")return a(e,null,t);if(!t)t={};r=i(r||n);var p=e._writableState;var u=e._readableState;var c=t.readable||t.readable!==false&&e.readable;var d=t.writable||t.writable!==false&&e.writable;var l=function(){if(!e.writable)m()};var m=function(){d=false;if(!c)r.call(e)};var h=function(){c=false;if(!d)r.call(e)};var g=function(t){r.call(e,t?new Error("exited with error code: "+t):null)};var f=function(t){r.call(e,t)};var y=function(){if(c&&!(u&&u.ended))return r.call(e,new Error("premature close"));if(d&&!(p&&p.ended))return r.call(e,new Error("premature close"))};var b=function(){e.req.on("finish",m)};if(s(e)){e.on("complete",m);e.on("abort",y);if(e.req)b();else e.on("request",b)}else if(d&&!p){e.on("end",l);e.on("close",l)}if(o(e))e.on("exit",g);e.on("end",h);e.on("finish",m);if(t.error!==false)e.on("error",f);e.on("close",y);return function(){e.removeListener("complete",m);e.removeListener("abort",y);e.removeListener("request",b);if(e.req)e.req.removeListener("finish",m);e.removeListener("end",l);e.removeListener("close",l);e.removeListener("finish",m);e.removeListener("exit",g);e.removeListener("end",h);e.removeListener("error",f);e.removeListener("close",y)}};e.exports=a},11:function(e){e.exports=wrappy;function wrappy(e,t){if(e&&t)return wrappy(e)(t);if(typeof e!=="function")throw new TypeError("need wrapper function");Object.keys(e).forEach(function(t){wrapper[t]=e[t]});return wrapper;function wrapper(){var t=new Array(arguments.length);for(var r=0;r<t.length;r++){t[r]=arguments[r]}var i=e.apply(this,t);var n=t[t.length-1];if(typeof i==="function"&&i!==n){Object.keys(n).forEach(function(e){i[e]=n[e]})}return i}}},16:function(e){e.exports=require("tls")},19:function(e,t,r){e.exports=authenticationPlugin;const{Deprecation:i}=r(692);const n=r(49);const s=n((e,t)=>e.warn(t));const o=r(533);const a=r(471);const p=r(349);function authenticationPlugin(e,t){if(t.auth){e.authenticate=(()=>{s(e.log,new i('[@octokit/rest] octokit.authenticate() is deprecated and has no effect when "auth" option is set on Octokit constructor'))});return}const r={octokit:e,auth:false};e.authenticate=o.bind(null,r);e.hook.Line truncated
+module.exports=function(e,t){"use strict";var r={};function __webpack_require__(t){if(r[t]){return r[t].exports}var i=r[t]={i:t,l:false,exports:{}};e[t].call(i.exports,i,i.exports,__webpack_require__);i.l=true;return i.exports}__webpack_require__.ab=__dirname+"/";function startup(){return __webpack_require__(131)}return startup()}({0:function(e,t,r){const{requestLog:i}=r(916);const{restEndpointMethods:n}=r(842);const s=r(529);const o=[r(190),r(19),i,r(148),n,r(430),r(850)];const a=s.plugin(o);function DeprecatedOctokit(e){const t=e&&e.log&&e.log.warn?e.log.warn:console.warn;t('[@octokit/rest] `const Octokit = require("@octokit/rest")` is deprecated. Use `const { Octokit } = require("@octokit/rest")` instead');return new a(e)}const p=Object.assign(DeprecatedOctokit,{Octokit:a});Object.keys(a).forEach(e=>{if(a.hasOwnProperty(e)){p[e]=a[e]}});e.exports=p},2:function(e,t,r){"use strict";const i=r(87);const n=r(118);const s=r(494);const o=(e,t)=>{if(!e&&t){throw new Error("You can't specify a `release` without specifying `platform`")}e=e||i.platform();let r;if(e==="darwin"){if(!t&&i.platform()==="darwin"){t=i.release()}const e=t?Number(t.split(".")[0])>15?"macOS":"OS X":"macOS";r=t?n(t).name:"";return e+(r?" "+r:"")}if(e==="linux"){if(!t&&i.platform()==="linux"){t=i.release()}r=t?t.replace(/^(\d+\.\d+).*/,"$1"):"";return"Linux"+(r?" "+r:"")}if(e==="win32"){if(!t&&i.platform()==="win32"){t=i.release()}r=t?s(t):"";return"Windows"+(r?" "+r:"")}return e};e.exports=o},3:function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:true});function isObject(e){return Object.prototype.toString.call(e)==="[object Object]"}function isPlainObject(e){var t,r;if(isObject(e)===false)return false;t=e.constructor;if(t===undefined)return true;r=t.prototype;if(isObject(r)===false)return false;if(r.hasOwnProperty("isPrototypeOf")===false){return false}return true}t.isPlainObject=isPlainObject},4:function(e,t){"use strict";var r="\ufeff";t.PrependBOM=PrependBOMWrapper;function PrependBOMWrapper(e,t){this.encoder=e;this.addBOM=true}PrependBOMWrapper.prototype.write=function(e){if(this.addBOM){e=r+e;this.addBOM=false}return this.encoder.write(e)};PrependBOMWrapper.prototype.end=function(){return this.encoder.end()};t.StripBOM=StripBOMWrapper;function StripBOMWrapper(e,t){this.decoder=e;this.pass=false;this.options=t||{}}StripBOMWrapper.prototype.write=function(e){var t=this.decoder.write(e);if(this.pass||!t)return t;if(t[0]===r){t=t.slice(1);if(typeof this.options.stripBOM==="function")this.options.stripBOM()}this.pass=true;return t};StripBOMWrapper.prototype.end=function(){return this.decoder.end()}},9:function(e,t,r){var i=r(49);var n=function(){};var s=function(e){return e.setHeader&&typeof e.abort==="function"};var o=function(e){return e.stdio&&Array.isArray(e.stdio)&&e.stdio.length===3};var a=function(e,t,r){if(typeof t==="function")return a(e,null,t);if(!t)t={};r=i(r||n);var p=e._writableState;var u=e._readableState;var c=t.readable||t.readable!==false&&e.readable;var d=t.writable||t.writable!==false&&e.writable;var l=function(){if(!e.writable)m()};var m=function(){d=false;if(!c)r.call(e)};var h=function(){c=false;if(!d)r.call(e)};var g=function(t){r.call(e,t?new Error("exited with error code: "+t):null)};var f=function(t){r.call(e,t)};var y=function(){if(c&&!(u&&u.ended))return r.call(e,new Error("premature close"));if(d&&!(p&&p.ended))return r.call(e,new Error("premature close"))};var b=function(){e.req.on("finish",m)};if(s(e)){e.on("complete",m);e.on("abort",y);if(e.req)b();else e.on("request",b)}else if(d&&!p){e.on("end",l);e.on("close",l)}if(o(e))e.on("exit",g);e.on("end",h);e.on("finish",m);if(t.error!==false)e.on("error",f);e.on("close",y);return function(){e.removeListener("complete",m);e.removeListener("abort",y);e.removeListener("request",b);if(e.req)e.req.removeListener("finish",m);e.removeListener("end",l);e.removeListener("close",l);e.removeListener("finish",m);e.removeListener("exit",g);e.removeListener("end",h);e.removeListener("error",f);e.removeListener("close",y)}};e.exports=a},11:function(e){e.exports=wrappy;function wrappy(e,t){if(e&&t)return wrappy(e)(t);if(typeof e!=="function")throw new TypeError("need wrapper function");Object.keys(e).forEach(function(t){wrapper[t]=e[t]});return wrapper;function wrapper(){var t=new Array(arguments.length);for(var r=0;r<t.length;r++){t[r]=arguments[r]}var i=e.apply(this,t);var n=t[t.length-1];if(typeof i==="function"&&i!==n){Object.keys(n).forEach(function(e){i[e]=n[e]})}return i}}},16:function(e){e.exports=require("tls")},19:function(e,t,r){e.exports=authenticationPlugin;const{Deprecation:i}=r(692);const n=r(49);const s=n((e,t)=>e.warn(t));const o=r(533);const a=r(471);const p=r(349);function authenticationPlugin(e,t){if(t.auth){e.authenticate=(()=>{s(e.log,new i('[@octokit/rest] octokit.authenticate() is deprecated and has no effect when "auth" option is set on Octokit constructor'))});return}const r={octokit:e,auth:false};e.authenticate=o.bind(null,r);e.hook.Line truncated

src/github.ts

@@ -35,6 +35,7 @@ export interface Releaser {
     body: string | undefined;
     draft: boolean | undefined;
     prerelease: boolean | undefined;
+    target_commitish: string | undefined;
   }): Promise<{ data: Release }>;
 
   updateRelease(params: {
@@ -77,6 +78,7 @@ export class GitHubReleaser implements Releaser {
     body: string | undefined;
     draft: boolean | undefined;
     prerelease: boolean | undefined;
+    target_commitish: string | undefined;
   }): Promise<{ data: Release }> {
     return this.github.repos.createRelease(params);
   }
@@ -165,7 +167,18 @@ export const release = async (
     });
 
     const release_id = existingRelease.data.id;
-    const target_commitish = existingRelease.data.target_commitish;
+    let target_commitish: string;
+    if (
+      config.input_target_commitish &&
+      config.input_target_commitish !== existingRelease.data.target_commitish
+    ) {
+      console.log(
+        `Updating commit from "${existingRelease.data.target_commitish}" to "${config.input_target_commitish}"`
+      );
+      target_commitish = config.input_target_commitish;
+    } else {
+      target_commitish = existingRelease.data.target_commitish;
+    }
     const tag_name = tag;
     const name = config.input_name || tag;
     const body = `${existingRelease.data.body}\n${releaseBody(config)}`;
@@ -191,7 +204,14 @@ export const release = async (
       const body = releaseBody(config);
       const draft = config.input_draft;
       const prerelease = config.input_prerelease;
-      console.log(`👩‍🏭 Creating new GitHub release for tag ${tag_name}...`);
+      const target_commitish = config.input_target_commitish;
+      let commitMessage: string = "";
+      if (target_commitish) {
+        commitMessage = ` using commit "${target_commitish}"`;
+      }
+      console.log(
+        `👩‍🏭 Creating new GitHub release for tag ${tag_name}${commitMessage}...`
+      );
       try {
         let release = await releaser.createRelease({
           owner,
@@ -200,7 +220,8 @@ export const release = async (
           name,
           body,
           draft,
-          prerelease
+          prerelease,
+          target_commitish
         });
         return release.data;
       } catch (error) {

src/util.ts

@@ -15,6 +15,7 @@ export interface Config {
   input_draft?: boolean;
   input_prerelease?: boolean;
   input_fail_on_unmatched_files?: boolean;
+  input_target_commitish?: string;
 }
 
 export const releaseBody = (config: Config): string | undefined => {
@@ -50,7 +51,8 @@ export const parseConfig = (env: Env): Config => {
     input_files: parseInputFiles(env.INPUT_FILES || ""),
     input_draft: env.INPUT_DRAFT === "true",
     input_prerelease: env.INPUT_PRERELEASE == "true",
-    input_fail_on_unmatched_files: env.INPUT_FAIL_ON_UNMATCHED_FILES == "true"
+    input_fail_on_unmatched_files: env.INPUT_FAIL_ON_UNMATCHED_FILES == "true",
+    input_target_commitish: env.INPUT_TARGET_COMMITISH
   };
 };