update readme

honor body_path input when provided.

.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: softprops

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.3
+
+* Fixed where `with: body_path` was not being used in generated GitHub releases
+
 ## 0.1.2
 
 * Add support for merging draft releases [#16](https://github.com/softprops/action-gh-release/pull/16)
@@ -22,6 +26,8 @@ GitHub actions inputs don't inherently support lists of things and one might lik
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+* Add support for prerelease annotated GitHub releases with the new input field `with.prerelease: true` [#19](https://github.com/softprops/action-gh-release/pull/19)
+
 ---
 
 ## 0.1.1

README.md

@@ -1,9 +1,28 @@
 
-# action gh-release [![](https://github.com/softprops/action-gh-release/workflows/Main/badge.svg)](https://github.com/softprops/action-gh-release/actions)
+<div align="center">
+  📦 :octocat:
+</div>
+<h1 align="center">
+  action gh-release
+</h1>
 
-> A GitHub Action for creating GitHub Releases on Linux, Windows, and OSX virtual environments
+<p align="center">
+   A GitHub Action for creating GitHub Releases on Linux, Windows, and OSX virtual environments
+</p>
+
+<div align="center">
+  <img src="demo.png"/>
+</div>
+
+<div align="center">
+  <a href="https://github.com/softprops/action-gh-release/actions">
+		<img src="https://github.com/softprops/action-gh-release/workflows/Main/badge.svg"/>
+	</a>
+</div>
+
+
+<br />
 
-![Screenshot](demo.png)
 
 
 > **⚠️ Note:** To use this action, you must have access to the [GitHub Actions](https://github.com/features/actions) feature. GitHub Actions are currently only available in public beta. You can [apply for the GitHub Actions beta here](https://github.com/features/actions/signup/).
@@ -28,7 +47,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@v1
       - name: Release
         uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/')
@@ -51,7 +70,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@v1
       - name: Release
         uses: softprops/action-gh-release@v1
         env:
@@ -80,7 +99,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@v1
       - name: Build
         run: echo ${{ github.sha }} > Release.txt
       - name: Test
@@ -106,7 +125,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@v1
       - name: Build
         run: echo ${{ github.sha }} > Release.txt
       - name: Test
@@ -140,7 +159,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@v1
       - name: Generate Changelog
         run: echo "# Good things have arrived" > ${{ github.workflow }}-CHANGELOG.txt
       - name: Release
@@ -163,7 +182,8 @@ The following are optional as `step.with` keys
 | `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             |
-| `files`     | String  | Newline-delimited globs of paths to assets to upload for release  |
+| `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                       |
 
 💡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__/release.txt

@@ -0,0 +1 @@
+bar

__tests__/util.test.ts

@@ -1,4 +1,10 @@
-import { isTag, paths, parseConfig, parseInputFiles } from "../src/util";
+import {
+  releaseBody,
+  isTag,
+  paths,
+  parseConfig,
+  parseInputFiles
+} from "../src/util";
 import * as assert from "assert";
 
 describe("util", () => {
@@ -16,6 +22,56 @@ describe("util", () => {
       );
     });
   });
+  describe("releaseBody", () => {
+    it("uses input body", () => {
+      assert.equal(
+        "foo",
+        releaseBody({
+          github_ref: "",
+          github_repository: "",
+          github_token: "",
+          input_body: "foo",
+          input_body_path: undefined,
+          input_draft: false,
+          input_prerelease: false,
+          input_files: [],
+          input_name: undefined
+        })
+      );
+    });
+    it("uses input body path", () => {
+      assert.equal(
+        "bar",
+        releaseBody({
+          github_ref: "",
+          github_repository: "",
+          github_token: "",
+          input_body: undefined,
+          input_body_path: "__tests__/release.txt",
+          input_draft: false,
+          input_prerelease: false,
+          input_files: [],
+          input_name: undefined
+        })
+      );
+    });
+    it("defaults to body when both body and body path are provided", () => {
+      assert.equal(
+        "foo",
+        releaseBody({
+          github_ref: "",
+          github_repository: "",
+          github_token: "",
+          input_body: "foo",
+          input_body_path: "__tests__/release.txt",
+          input_draft: false,
+          input_prerelease: false,
+          input_files: [],
+          input_name: undefined
+        })
+      );
+    });
+  });
   describe("parseConfig", () => {
     it("parses basic config", () => {
       assert.deepStrictEqual(parseConfig({}), {
@@ -25,6 +81,7 @@ describe("util", () => {
         input_body: undefined,
         input_body_path: undefined,
         input_draft: false,
+        input_prerelease: false,
         input_files: [],
         input_name: undefined
       });

action.yml

@@ -6,14 +6,17 @@ inputs:
   body:
     description: 'Note-worthy description of changes in release'
     required: false
-  body-path:
+  body_path:
     description: 'Path to load note-worthy description of changes in release from'
     required: false
   name:
     description: 'Gives the release a custom name. Defaults to tag name'
     required: false
   draft:
-    description: 'Creates a draft release'
+    description: 'Creates a draft release. Defaults to false'
+    required: false
+  prerelease:
+    description: 'Identify the release as a prerelease. Defaults to false'
     required: false
   files:
     description: 'Newline-delimited list of path globs for asset files to upload'

lib/github.js

@@ -16,6 +16,7 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("./util");
 const fs_1 = require("fs");
 const mime_1 = require("mime");
 const path_1 = require("path");
@@ -98,8 +99,9 @@ exports.release = (config, releaser) => __awaiter(void 0, void 0, void 0, functi
             try {
                 const tag_name = tag;
                 const name = config.input_name || tag;
-                const body = config.input_body;
+                const body = util_1.releaseBody(config);
                 const draft = config.input_draft;
+                const prerelease = config.input_prerelease;
                 console.log(`👩‍🏭 Creating new GitHub release for tag ${tag_name}...`);
                 let release = yield releaser.createRelease({
                     owner,
@@ -107,7 +109,8 @@ exports.release = (config, releaser) => __awaiter(void 0, void 0, void 0, functi
                     tag_name,
                     name,
                     body,
-                    draft
+                    draft,
+                    prerelease
                 });
                 return release.data;
             }

lib/util.js

@@ -9,6 +9,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const glob = __importStar(require("glob"));
 const fs_1 = require("fs");
+exports.releaseBody = (config) => {
+    return (config.input_body ||
+        (config.input_body_path &&
+            fs_1.readFileSync(config.input_body_path).toString("utf8")));
+};
 exports.parseInputFiles = (files) => {
     return files.split(/\r?\n/).reduce((acc, line) => acc
         .concat(line.split(","))
@@ -24,7 +29,8 @@ exports.parseConfig = (env) => {
         input_body: env.INPUT_BODY,
         input_body_path: env.INPUT_BODY_PATH,
         input_files: exports.parseInputFiles(env.INPUT_FILES || ""),
-        input_draft: env.INPUT_DRAFT === "true"
+        input_draft: env.INPUT_DRAFT === "true",
+        input_prerelease: env.INPUT_PRERELEASE == "true"
     };
 };
 exports.paths = (patterns) => {

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "action-gh-release",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -3437,6 +3437,12 @@
       "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz",
       "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk="
     },
+    "lodash.memoize": {
+      "version": "4.1.2",
+      "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz",
+      "integrity": "sha1-vMbEmkKihA7Zl/Mj6tpezRguC/4=",
+      "dev": true
+    },
     "lodash.set": {
       "version": "4.3.2",
       "resolved": "https://registry.npmjs.org/lodash.set/-/lodash.set-4.3.2.tgz",
@@ -4826,15 +4832,16 @@
       "dev": true
     },
     "ts-jest": {
-      "version": "24.0.2",
-      "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-24.0.2.tgz",
-      "integrity": "sha512-h6ZCZiA1EQgjczxq+uGLXQlNgeg02WWJBbeT8j6nyIBRQdglqbvzDoHahTEIiS6Eor6x8mK6PfZ7brQ9Q6tzHw==",
+      "version": "24.1.0",
+      "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-24.1.0.tgz",
+      "integrity": "sha512-HEGfrIEAZKfu1pkaxB9au17b1d9b56YZSqz5eCVE8mX68+5reOvlM93xGOzzCREIov9mdH7JBG+s0UyNAqr0tQ==",
       "dev": true,
       "requires": {
         "bs-logger": "0.x",
         "buffer-from": "1.x",
         "fast-json-stable-stringify": "2.x",
         "json5": "2.x",
+        "lodash.memoize": "4.x",
         "make-error": "1.x",
         "mkdirp": "0.x",
         "resolve": "1.x",
@@ -4884,9 +4891,9 @@
       }
     },
     "typescript": {
-      "version": "3.6.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.6.2.tgz",
-      "integrity": "sha512-lmQ4L+J6mnu3xweP8+rOrUwzmN+MRAj7TgtJtDaXE5PMyX2kCrklhg3rvOsOIfNeAWMQWO2F1GPc1kMD2vLAfw==",
+      "version": "3.6.3",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.6.3.tgz",
+      "integrity": "sha512-N7bceJL1CtRQ2RiG0AQME13ksR7DiuQh/QehubYcghzv20tnh+MQnQIuJddTmsbqYj+dztchykemz0zFzlvdQw==",
       "dev": true
     },
     "typescript-formatter": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "action-gh-release",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "private": true,
   "description": "GitHub Action for creating GitHub Releases",
   "main": "lib/main.js",
@@ -26,14 +26,14 @@
   },
   "devDependencies": {
     "@types/glob": "^7.1.1",
-    "@types/jest": "^24.0.13",
+    "@types/jest": "^24.0.18",
     "@types/mime": "^2.0.1",
     "@types/node": "^12.7.4",
-    "jest": "^24.8.0",
-    "jest-circus": "^24.7.1",
+    "jest": "^24.9.0",
+    "jest-circus": "^24.9.0",
     "prettier": "1.18.2",
-    "ts-jest": "^24.0.2",
-    "typescript": "^3.5.1",
+    "ts-jest": "^24.1.0",
+    "typescript": "^3.6.3",
     "typescript-formatter": "^7.2.2"
   }
 }

src/github.ts

@@ -1,5 +1,5 @@
 import { GitHub } from "@actions/github";
-import { Config } from "./util";
+import { Config, releaseBody } from "./util";
 import { lstatSync, readFileSync } from "fs";
 import { getType } from "mime";
 import { basename } from "path";
@@ -31,6 +31,7 @@ export interface Releaser {
     name: string;
     body: string | undefined;
     draft: boolean | undefined;
+    prerelease: boolean | undefined;
   }): Promise<{ data: Release }>;
 
   allReleases(params: {
@@ -60,6 +61,7 @@ export class GitHubReleaser implements Releaser {
     name: string;
     body: string | undefined;
     draft: boolean | undefined;
+    prerelease: boolean | undefined;
   }): Promise<{ data: Release }> {
     return this.github.repos.createRelease(params);
   }
@@ -136,8 +138,9 @@ export const release = async (
       try {
         const tag_name = tag;
         const name = config.input_name || tag;
-        const body = config.input_body;
+        const body = releaseBody(config);
         const draft = config.input_draft;
+        const prerelease = config.input_prerelease;
         console.log(`👩‍🏭 Creating new GitHub release for tag ${tag_name}...`);
         let release = await releaser.createRelease({
           owner,
@@ -145,7 +148,8 @@ export const release = async (
           tag_name,
           name,
           body,
-          draft
+          draft,
+          prerelease
         });
         return release.data;
       } catch (error) {

src/util.ts

@@ -1,5 +1,5 @@
 import * as glob from "glob";
-import { lstatSync } from "fs";
+import { lstatSync, readFileSync } from "fs";
 
 export interface Config {
   github_token: string;
@@ -11,8 +11,17 @@ export interface Config {
   input_body_path?: string;
   input_files?: string[];
   input_draft?: boolean;
+  input_prerelease?: boolean;
 }
 
+export const releaseBody = (config: Config): string | undefined => {
+  return (
+    config.input_body ||
+    (config.input_body_path &&
+      readFileSync(config.input_body_path).toString("utf8"))
+  );
+};
+
 type Env = { [key: string]: string | undefined };
 
 export const parseInputFiles = (files: string): string[] => {
@@ -35,7 +44,8 @@ export const parseConfig = (env: Env): Config => {
     input_body: env.INPUT_BODY,
     input_body_path: env.INPUT_BODY_PATH,
     input_files: parseInputFiles(env.INPUT_FILES || ""),
-    input_draft: env.INPUT_DRAFT === "true"
+    input_draft: env.INPUT_DRAFT === "true",
+    input_prerelease: env.INPUT_PRERELEASE == "true"
   };
 };