update readme

add support for multi-line delimited assets

CHANGELOG.md

@@ -1,9 +1,39 @@
-## 0.1.0
+## 0.1.2
 
-* Initial release
+* Add support for merging draft releases [#16](https://github.com/softprops/action-gh-release/pull/16)
+
+GitHub's api doesn't explicitly have a way of fetching a draft release by tag name which caused draft releases to appear as separate releases when used in a build matrix.
+This is now fixed.
+
+* Add support for newline-delimited asset list [#18](https://github.com/softprops/action-gh-release/pull/18)
+
+GitHub actions inputs don't inherently support lists of things and one might like to append a list of files to include in a release. Previously this was possible using a comma-delimited list of asset path patterns to upload. You can now provide these as a newline delimieted list for better readability
+
+```yaml
+  - name: Release
+    uses: softprops/action-gh-release@v1
+    if: startsWith(github.ref, 'refs/tags/')
+    with:
+      files: |
+        filea.txt
+        fileb.txt
+        filec.txt
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+* Add support for prerelease annotated GitHub releases with the new input field `with.prerelease: true`
+
+---
 
 ## 0.1.1
 
 * Add support for publishing releases on all supported virtual hosts
 
 You'll need to remove `docker://` prefix and use the `@v1` action tag
+
+---
+
+## 0.1.0
+
+* Initial release

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+## bootstrapping
+
+This a [JavaScript](https://help.github.com/en/articles/about-actions#types-of-actions)  action but uses [TypeScript](https://www.typescriptlang.org/docs/home.html) to generate that JavaScript.
+
+You can bootstrap your envrinment with a modern version of npm and by running `npm i` at the root of this repo.
+
+## testing
+
+Tests can be found under under `__tests__` directory and are runnable with the `npm t` command
+
+## source code
+
+Source code can be found under the `src` directory. Running `npm run build` will generate the JavaScript that will run within GitHub workflows.
+
+## formatting
+
+A minimal attempt at keeping a consistent code style is can be applied by running `npm run fmt`
+

README.md

@@ -1,12 +1,13 @@
 
 # action gh-release [![](https://github.com/softprops/action-gh-release/workflows/Main/badge.svg)](https://github.com/softprops/action-gh-release/actions)
 
-> A GitHub Action for creating GitHub Releases
+> A GitHub Action for creating GitHub Releases on Linux, Windows, and OSX virtual environments
+
+![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/).
 
-> **⚠️ Note:** This action was previously implemented as a docker container, limiting its use to GitHub Actions Linux virtual environments only. With recent releases, we now support cross platform usage. You'll need to remove the `docker://` prefix in these versions
-
 ## 🤸 Usage
 
 ### 🚥 Limit releases to pushes to tags
@@ -64,7 +65,7 @@ You can can configure a number of options for your
 GitHub release and all are optional.
 
 A common case for GitHub releases is to upload your binary after its been validated and packaged.
-Use the `with.files` input to declare a comma-separated list of glob expressions matching the files
+Use the `with.files` input to declare a newline-delimited list of glob expressions matching the files
 you wish to upload to GitHub releases. If you'd like you can just list the files by name directly.
 
 Below is an example of uploading a single asset named `Release.txt`
@@ -93,6 +94,36 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+Below is an example of uploading more than one asset with a GitHub release
+
+```yaml
+name: Main
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+      - name: Build
+        run: echo ${{ github.sha }} > Release.txt
+      - name: Test
+        run: cat Release.txt
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: |
+            Release.txt
+            LICENSE
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+> **⚠️ Note:** Notice the `|` in the yaml syntax above ☝️. That let's you effectively declare a multi-line yaml string. You can learn more about multi-line yaml syntax [here](https://yaml-multiline.info)
+
 ### 📝 External release notes
 
 Many systems exist that can help generate release notes for you. This action supports
@@ -132,7 +163,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  | Comma-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.
@@ -145,4 +177,7 @@ The following are *required* as `step.env` keys
 |----------------|--------------------------------------|
 | `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets`|
 
+
+> **⚠️ Note:** This action was previously implemented as a docker container, limiting its use to GitHub Actions Linux virtual environments only. With recent releases, we now support cross platform usage. You'll need to remove the `docker://` prefix in these versions
+
 Doug Tangren (softprops) 2019

__tests__/util.test.ts

@@ -1,7 +1,36 @@
-import { isTag, paths } from "../src/util";
+import { isTag, paths, parseConfig, parseInputFiles } from "../src/util";
 import * as assert from "assert";
 
 describe("util", () => {
+  describe("parseInputFiles", () => {
+    it("parses empty strings", () => {
+      assert.deepStrictEqual(parseInputFiles(""), []);
+    });
+    it("parses comma-delimited strings", () => {
+      assert.deepStrictEqual(parseInputFiles("foo,bar"), ["foo", "bar"]);
+    });
+    it("parses newline and comma-delimited (and then some)", () => {
+      assert.deepStrictEqual(
+        parseInputFiles("foo,bar\nbaz,boom,\n\ndoom,loom "),
+        ["foo", "bar", "baz", "boom", "doom", "loom"]
+      );
+    });
+  });
+  describe("parseConfig", () => {
+    it("parses basic config", () => {
+      assert.deepStrictEqual(parseConfig({}), {
+        github_ref: "",
+        github_repository: "",
+        github_token: "",
+        input_body: undefined,
+        input_body_path: undefined,
+        input_draft: false,
+        input_prerelease: false,
+        input_files: [],
+        input_name: undefined
+      });
+    });
+  });
   describe("isTag", () => {
     it("returns true for tags", async () => {
       assert.equal(isTag("refs/tags/foo"), true);

action.yml

@@ -13,10 +13,13 @@ inputs:
     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: 'Comma-delimited list of path globs for asset files to upload'
+    description: 'Newline-delimited list of path globs for asset files to upload'
     required: false
 env:
   'GITHUB_TOKEN': 'As provided by Github Actions'

lib/github.js

@@ -8,10 +8,32 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    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 fs_1 = require("fs");
 const mime_1 = require("mime");
 const path_1 = require("path");
+class GitHubReleaser {
+    constructor(github) {
+        this.github = github;
+    }
+    getReleaseByTag(params) {
+        return this.github.repos.getReleaseByTag(params);
+    }
+    createRelease(params) {
+        return this.github.repos.createRelease(params);
+    }
+    allReleases(params) {
+        return this.github.paginate.iterator(this.github.repos.listReleases.endpoint.merge(params));
+    }
+}
+exports.GitHubReleaser = GitHubReleaser;
 exports.asset = (path) => {
     return {
         name: path_1.basename(path),
@@ -36,11 +58,35 @@ exports.upload = (gh, url, path) => __awaiter(void 0, void 0, void 0, function*
         file
     });
 });
-exports.release = (config, gh) => __awaiter(void 0, void 0, void 0, function* () {
+exports.release = (config, releaser) => __awaiter(void 0, void 0, void 0, function* () {
+    var e_1, _a;
     const [owner, repo] = config.github_repository.split("/");
     const tag = config.github_ref.replace("refs/tags/", "");
     try {
-        let release = yield gh.repos.getReleaseByTag({
+        // you can't get a an existing draft by tag
+        // so we must find one in the list of all releases
+        if (config.input_draft) {
+            try {
+                for (var _b = __asyncValues(releaser.allReleases({
+                    owner,
+                    repo
+                })), _c; _c = yield _b.next(), !_c.done;) {
+                    const response = _c.value;
+                    let release = response.data.find(release => release.tag_name === tag);
+                    if (release) {
+                        return release;
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        }
+        let release = yield releaser.getReleaseByTag({
             owner,
             repo,
             tag
@@ -54,21 +100,23 @@ exports.release = (config, gh) => __awaiter(void 0, void 0, void 0, function* ()
                 const name = config.input_name || tag;
                 const body = config.input_body;
                 const draft = config.input_draft;
+                const prerelease = config.input_prerelease;
                 console.log(`👩‍🏭 Creating new GitHub release for tag ${tag_name}...`);
-                let release = yield gh.repos.createRelease({
+                let release = yield releaser.createRelease({
                     owner,
                     repo,
                     tag_name,
                     name,
                     body,
-                    draft
+                    draft,
+                    prerelease
                 });
                 return release.data;
             }
             catch (error) {
                 // presume a race with competing metrix runs
                 console.log(`⚠️ GitHub release failed with status: ${error.status}, retrying...`);
-                return exports.release(config, gh);
+                return exports.release(config, releaser);
             }
         }
         else {

lib/main.js

@@ -22,7 +22,7 @@ function run() {
                 throw new Error(`⚠️ GitHub Releases requires a tag`);
             }
             const gh = new github_2.GitHub(config.github_token);
-            let rel = yield github_1.release(config, gh);
+            let rel = yield github_1.release(config, new github_1.GitHubReleaser(gh));
             if (config.input_files) {
                 util_1.paths(config.input_files).forEach((path) => __awaiter(this, void 0, void 0, function* () {
                     yield github_1.upload(gh, rel.upload_url, path);

lib/util.js

@@ -9,6 +9,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const glob = __importStar(require("glob"));
 const fs_1 = require("fs");
+exports.parseInputFiles = (files) => {
+    return files.split(/\r?\n/).reduce((acc, line) => acc
+        .concat(line.split(","))
+        .filter(pat => pat)
+        .map(pat => pat.trim()), []);
+};
 exports.parseConfig = (env) => {
     return {
         github_token: env.GITHUB_TOKEN || "",
@@ -17,8 +23,9 @@ exports.parseConfig = (env) => {
         input_name: env.INPUT_NAME,
         input_body: env.INPUT_BODY,
         input_body_path: env.INPUT_BODY_PATH,
-        input_files: (env.INPUT_FILES || "").split(","),
-        input_draft: env.INPUT_DRAFT === "true"
+        input_files: exports.parseInputFiles(env.INPUT_FILES || ""),
+        input_draft: env.INPUT_DRAFT === "true",
+        input_prerelease: env.INPUT_PRERELEASE == "true"
     };
 };
 exports.paths = (patterns) => {

src/github.ts

@@ -14,6 +14,66 @@ export interface ReleaseAsset {
 export interface Release {
   upload_url: string;
   html_url: string;
+  tag_name: string;
+}
+
+export interface Releaser {
+  getReleaseByTag(params: {
+    owner: string;
+    repo: string;
+    tag: string;
+  }): Promise<{ data: Release }>;
+
+  createRelease(params: {
+    owner: string;
+    repo: string;
+    tag_name: string;
+    name: string;
+    body: string | undefined;
+    draft: boolean | undefined;
+    prerelease: boolean | undefined;
+  }): Promise<{ data: Release }>;
+
+  allReleases(params: {
+    owner: string;
+    repo: string;
+  }): AsyncIterableIterator<{ data: Release[] }>;
+}
+
+export class GitHubReleaser implements Releaser {
+  github: GitHub;
+  constructor(github: GitHub) {
+    this.github = github;
+  }
+
+  getReleaseByTag(params: {
+    owner: string;
+    repo: string;
+    tag: string;
+  }): Promise<{ data: Release }> {
+    return this.github.repos.getReleaseByTag(params);
+  }
+
+  createRelease(params: {
+    owner: string;
+    repo: string;
+    tag_name: string;
+    name: string;
+    body: string | undefined;
+    draft: boolean | undefined;
+    prerelease: boolean | undefined;
+  }): Promise<{ data: Release }> {
+    return this.github.repos.createRelease(params);
+  }
+
+  allReleases(params: {
+    owner: string;
+    repo: string;
+  }): AsyncIterableIterator<{ data: Release[] }> {
+    return this.github.paginate.iterator(
+      this.github.repos.listReleases.endpoint.merge(params)
+    );
+  }
 }
 
 export const asset = (path: string): ReleaseAsset => {
@@ -47,11 +107,27 @@ export const upload = async (
   });
 };
 
-export const release = async (config: Config, gh: GitHub): Promise<Release> => {
+export const release = async (
+  config: Config,
+  releaser: Releaser
+): Promise<Release> => {
   const [owner, repo] = config.github_repository.split("/");
   const tag = config.github_ref.replace("refs/tags/", "");
   try {
-    let release = await gh.repos.getReleaseByTag({
+    // you can't get a an existing draft by tag
+    // so we must find one in the list of all releases
+    if (config.input_draft) {
+      for await (const response of releaser.allReleases({
+        owner,
+        repo
+      })) {
+        let release = response.data.find(release => release.tag_name === tag);
+        if (release) {
+          return release;
+        }
+      }
+    }
+    let release = await releaser.getReleaseByTag({
       owner,
       repo,
       tag
@@ -64,14 +140,16 @@ export const release = async (config: Config, gh: GitHub): Promise<Release> => {
         const name = config.input_name || tag;
         const body = config.input_body;
         const draft = config.input_draft;
+        const prerelease = config.input_prerelease;
         console.log(`👩‍🏭 Creating new GitHub release for tag ${tag_name}...`);
-        let release = await gh.repos.createRelease({
+        let release = await releaser.createRelease({
           owner,
           repo,
           tag_name,
           name,
           body,
-          draft
+          draft,
+          prerelease
         });
         return release.data;
       } catch (error) {
@@ -79,7 +157,7 @@ export const release = async (config: Config, gh: GitHub): Promise<Release> => {
         console.log(
           `⚠️ GitHub release failed with status: ${error.status}, retrying...`
         );
-        return release(config, gh);
+        return release(config, releaser);
       }
     } else {
       console.log(

src/main.ts

@@ -1,5 +1,5 @@
 import { paths, parseConfig, isTag } from "./util";
-import { release, upload } from "./github";
+import { release, upload, GitHubReleaser } from "./github";
 import { setFailed } from "@actions/core";
 import { GitHub } from "@actions/github";
 import { env } from "process";
@@ -11,7 +11,7 @@ async function run() {
       throw new Error(`⚠️ GitHub Releases requires a tag`);
     }
     const gh = new GitHub(config.github_token);
-    let rel = await release(config, gh);
+    let rel = await release(config, new GitHubReleaser(gh));
     if (config.input_files) {
       paths(config.input_files).forEach(async path => {
         await upload(gh, rel.upload_url, path);

src/util.ts

@@ -11,10 +11,22 @@ export interface Config {
   input_body_path?: string;
   input_files?: string[];
   input_draft?: boolean;
+  input_prerelease?: boolean;
 }
 
 type Env = { [key: string]: string | undefined };
 
+export const parseInputFiles = (files: string): string[] => {
+  return files.split(/\r?\n/).reduce<string[]>(
+    (acc, line) =>
+      acc
+        .concat(line.split(","))
+        .filter(pat => pat)
+        .map(pat => pat.trim()),
+    []
+  );
+};
+
 export const parseConfig = (env: Env): Config => {
   return {
     github_token: env.GITHUB_TOKEN || "",
@@ -23,8 +35,9 @@ export const parseConfig = (env: Env): Config => {
     input_name: env.INPUT_NAME,
     input_body: env.INPUT_BODY,
     input_body_path: env.INPUT_BODY_PATH,
-    input_files: (env.INPUT_FILES || "").split(","),
-    input_draft: env.INPUT_DRAFT === "true"
+    input_files: parseInputFiles(env.INPUT_FILES || ""),
+    input_draft: env.INPUT_DRAFT === "true",
+    input_prerelease: env.INPUT_PRERELEASE == "true"
   };
 };