support multi-line delimited assets. fixes #15
This commit is contained in:
parent
a6281eb824
commit
3af8783d41
34
README.md
34
README.md
@ -65,7 +65,7 @@ You can can configure a number of options for your
|
|||||||
GitHub release and all are optional.
|
GitHub release and all are optional.
|
||||||
|
|
||||||
A common case for GitHub releases is to upload your binary after its been validated and packaged.
|
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.
|
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`
|
Below is an example of uploading a single asset named `Release.txt`
|
||||||
@ -94,6 +94,36 @@ jobs:
|
|||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Below is an example of uploading more than one asset.
|
||||||
|
|
||||||
|
```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
|
### 📝 External release notes
|
||||||
|
|
||||||
Many systems exist that can help generate release notes for you. This action supports
|
Many systems exist that can help generate release notes for you. This action supports
|
||||||
@ -133,7 +163,7 @@ The following are optional as `step.with` keys
|
|||||||
| `body` | String | Text communicating notable changes in this release |
|
| `body` | String | Text communicating notable changes in this release |
|
||||||
| `body_path` | String | Path to load 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 |
|
| `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 |
|
| `files` | String | Newline-delimited globs of paths to assets to upload for release |
|
||||||
| `name` | String | Name of the release. defaults to tag name |
|
| `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.
|
💡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.
|
||||||
|
@ -1,7 +1,35 @@
|
|||||||
import { isTag, paths } from "../src/util";
|
import { isTag, paths, parseConfig, parseInputFiles } from "../src/util";
|
||||||
import * as assert from "assert";
|
import * as assert from "assert";
|
||||||
|
|
||||||
describe("util", () => {
|
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_files: [],
|
||||||
|
input_name: undefined
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
describe("isTag", () => {
|
describe("isTag", () => {
|
||||||
it("returns true for tags", async () => {
|
it("returns true for tags", async () => {
|
||||||
assert.equal(isTag("refs/tags/foo"), true);
|
assert.equal(isTag("refs/tags/foo"), true);
|
||||||
|
@ -9,6 +9,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
const glob = __importStar(require("glob"));
|
const glob = __importStar(require("glob"));
|
||||||
const fs_1 = require("fs");
|
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) => {
|
exports.parseConfig = (env) => {
|
||||||
return {
|
return {
|
||||||
github_token: env.GITHUB_TOKEN || "",
|
github_token: env.GITHUB_TOKEN || "",
|
||||||
@ -17,7 +23,7 @@ exports.parseConfig = (env) => {
|
|||||||
input_name: env.INPUT_NAME,
|
input_name: env.INPUT_NAME,
|
||||||
input_body: env.INPUT_BODY,
|
input_body: env.INPUT_BODY,
|
||||||
input_body_path: env.INPUT_BODY_PATH,
|
input_body_path: env.INPUT_BODY_PATH,
|
||||||
input_files: (env.INPUT_FILES || "").split(","),
|
input_files: exports.parseInputFiles(env.INPUT_FILES || ""),
|
||||||
input_draft: env.INPUT_DRAFT === "true"
|
input_draft: env.INPUT_DRAFT === "true"
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
13
src/util.ts
13
src/util.ts
@ -15,6 +15,17 @@ export interface Config {
|
|||||||
|
|
||||||
type Env = { [key: string]: string | undefined };
|
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 => {
|
export const parseConfig = (env: Env): Config => {
|
||||||
return {
|
return {
|
||||||
github_token: env.GITHUB_TOKEN || "",
|
github_token: env.GITHUB_TOKEN || "",
|
||||||
@ -23,7 +34,7 @@ export const parseConfig = (env: Env): Config => {
|
|||||||
input_name: env.INPUT_NAME,
|
input_name: env.INPUT_NAME,
|
||||||
input_body: env.INPUT_BODY,
|
input_body: env.INPUT_BODY,
|
||||||
input_body_path: env.INPUT_BODY_PATH,
|
input_body_path: env.INPUT_BODY_PATH,
|
||||||
input_files: (env.INPUT_FILES || "").split(","),
|
input_files: parseInputFiles(env.INPUT_FILES || ""),
|
||||||
input_draft: env.INPUT_DRAFT === "true"
|
input_draft: env.INPUT_DRAFT === "true"
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
Loading…
x
Reference in New Issue
Block a user