mirror of
https://github.com/softprops/action-gh-release.git
synced 2025-06-28 06:16:01 +00:00
Compare commits
No commits in common. "master" and "v2.3.1" have entirely different histories.
14 changed files with 416 additions and 385 deletions
8
.github/dependabot.yml
vendored
8
.github/dependabot.yml
vendored
|
@ -12,9 +12,13 @@ updates:
|
||||||
- dependency-name: node-fetch
|
- dependency-name: node-fetch
|
||||||
versions:
|
versions:
|
||||||
- ">=3.0.0"
|
- ">=3.0.0"
|
||||||
- dependency-name: "@types/node"
|
# ignore mime and @types/mime per https://github.com/softprops/action-gh-release/pull/475
|
||||||
|
- dependency-name: mime
|
||||||
versions:
|
versions:
|
||||||
- ">=22.0.0"
|
- ">=4.0.0"
|
||||||
|
- dependency-name: "@types/mime"
|
||||||
|
versions:
|
||||||
|
- ">=4.0.0"
|
||||||
commit-message:
|
commit-message:
|
||||||
prefix: "chore(deps)"
|
prefix: "chore(deps)"
|
||||||
- package-ecosystem: github-actions
|
- package-ecosystem: github-actions
|
||||||
|
|
|
@ -1,16 +0,0 @@
|
||||||
# Build outputs
|
|
||||||
dist/
|
|
||||||
lib/
|
|
||||||
coverage/
|
|
||||||
|
|
||||||
# Dependencies
|
|
||||||
node_modules/
|
|
||||||
|
|
||||||
# Misc
|
|
||||||
.github/
|
|
||||||
*.log
|
|
||||||
.DS_Store
|
|
||||||
__tests__/release.txt
|
|
||||||
|
|
||||||
# Package files
|
|
||||||
package-lock.json
|
|
|
@ -1,11 +0,0 @@
|
||||||
/**
|
|
||||||
* @type {import('prettier').Config}
|
|
||||||
*/
|
|
||||||
module.exports = {
|
|
||||||
trailingComma: 'all',
|
|
||||||
tabWidth: 2,
|
|
||||||
semi: true,
|
|
||||||
singleQuote: true,
|
|
||||||
printWidth: 100,
|
|
||||||
bracketSpacing: true,
|
|
||||||
};
|
|
|
@ -1,7 +1,3 @@
|
||||||
## 2.3.2
|
|
||||||
|
|
||||||
* fix: revert fs `readableWebStream` change
|
|
||||||
|
|
||||||
## 2.3.1
|
## 2.3.1
|
||||||
|
|
||||||
### Bug fixes 🐛
|
### Bug fixes 🐛
|
||||||
|
|
|
@ -185,7 +185,6 @@ The following are optional as `step.with` keys
|
||||||
| `prerelease` | Boolean | Indicator of whether or not is a prerelease |
|
| `prerelease` | Boolean | Indicator of whether or not is a prerelease |
|
||||||
| `preserve_order` | Boolean | Indicator of whether order of files should be preserved when uploading assets |
|
| `preserve_order` | Boolean | Indicator of whether order of files should be preserved when uploading assets |
|
||||||
| `files` | String | Newline-delimited globs of paths to assets to upload for release |
|
| `files` | String | Newline-delimited globs of paths to assets to upload for release |
|
||||||
| `overwrite_files` | Boolean | Indicator of whether files should be overwritten when they already exist. Defaults to true |
|
|
||||||
| `name` | String | Name of the release. defaults to tag name |
|
| `name` | String | Name of the release. defaults to tag name |
|
||||||
| `tag_name` | String | Name of a tag. defaults to `github.ref_name` |
|
| `tag_name` | String | Name of a tag. defaults to `github.ref_name` |
|
||||||
| `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing |
|
| `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing |
|
||||||
|
|
|
@ -1,56 +1,63 @@
|
||||||
import { asset, findTagFromReleases, mimeOrDefault, Release, Releaser } from '../src/github';
|
import * as assert from "assert";
|
||||||
|
import {
|
||||||
|
mimeOrDefault,
|
||||||
|
asset,
|
||||||
|
Releaser,
|
||||||
|
Release,
|
||||||
|
findTagFromReleases,
|
||||||
|
} from "../src/github";
|
||||||
|
|
||||||
import { assert, describe, it } from 'vitest';
|
import { describe, it } from "vitest";
|
||||||
|
|
||||||
describe('github', () => {
|
describe("github", () => {
|
||||||
describe('mimeOrDefault', () => {
|
describe("mimeOrDefault", () => {
|
||||||
it('returns a specific mime for common path', async () => {
|
it("returns a specific mime for common path", async () => {
|
||||||
assert.equal(mimeOrDefault('foo.tar.gz'), 'application/gzip');
|
assert.equal(mimeOrDefault("foo.tar.gz"), "application/gzip");
|
||||||
});
|
});
|
||||||
it('returns default mime for uncommon path', async () => {
|
it("returns default mime for uncommon path", async () => {
|
||||||
assert.equal(mimeOrDefault('foo.uncommon'), 'application/octet-stream');
|
assert.equal(mimeOrDefault("foo.uncommon"), "application/octet-stream");
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('asset', () => {
|
describe("asset", () => {
|
||||||
it('derives asset info from a path', async () => {
|
it("derives asset info from a path", async () => {
|
||||||
const { name, mime, size } = asset('tests/data/foo/bar.txt');
|
const { name, mime, size } = asset("tests/data/foo/bar.txt");
|
||||||
assert.equal(name, 'bar.txt');
|
assert.equal(name, "bar.txt");
|
||||||
assert.equal(mime, 'text/plain');
|
assert.equal(mime, "text/plain");
|
||||||
assert.equal(size, 10);
|
assert.equal(size, 10);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('findTagFromReleases', () => {
|
describe("findTagFromReleases", () => {
|
||||||
const owner = 'owner';
|
const owner = "owner";
|
||||||
const repo = 'repo';
|
const repo = "repo";
|
||||||
|
|
||||||
const mockRelease: Release = {
|
const mockRelease: Release = {
|
||||||
id: 1,
|
id: 1,
|
||||||
upload_url: `https://api.github.com/repos/${owner}/${repo}/releases/1/assets`,
|
upload_url: `https://api.github.com/repos/${owner}/${repo}/releases/1/assets`,
|
||||||
html_url: `https://github.com/${owner}/${repo}/releases/tag/v1.0.0`,
|
html_url: `https://github.com/${owner}/${repo}/releases/tag/v1.0.0`,
|
||||||
tag_name: 'v1.0.0',
|
tag_name: "v1.0.0",
|
||||||
name: 'Test Release',
|
name: "Test Release",
|
||||||
body: 'Test body',
|
body: "Test body",
|
||||||
target_commitish: 'main',
|
target_commitish: "main",
|
||||||
draft: false,
|
draft: false,
|
||||||
prerelease: false,
|
prerelease: false,
|
||||||
assets: [],
|
assets: [],
|
||||||
} as const;
|
} as const;
|
||||||
|
|
||||||
const mockReleaser: Releaser = {
|
const mockReleaser: Releaser = {
|
||||||
getReleaseByTag: () => Promise.reject('Not implemented'),
|
getReleaseByTag: () => Promise.reject("Not implemented"),
|
||||||
createRelease: () => Promise.reject('Not implemented'),
|
createRelease: () => Promise.reject("Not implemented"),
|
||||||
updateRelease: () => Promise.reject('Not implemented'),
|
updateRelease: () => Promise.reject("Not implemented"),
|
||||||
allReleases: async function* () {
|
allReleases: async function* () {
|
||||||
yield { data: [mockRelease] };
|
yield { data: [mockRelease] };
|
||||||
},
|
},
|
||||||
} as const;
|
} as const;
|
||||||
|
|
||||||
describe('when the tag_name is not an empty string', () => {
|
describe("when the tag_name is not an empty string", () => {
|
||||||
const targetTag = 'v1.0.0';
|
const targetTag = "v1.0.0";
|
||||||
|
|
||||||
it('finds a matching release in first batch of results', async () => {
|
it("finds a matching release in first batch of results", async () => {
|
||||||
const targetRelease = {
|
const targetRelease = {
|
||||||
...mockRelease,
|
...mockRelease,
|
||||||
owner,
|
owner,
|
||||||
|
@ -61,7 +68,7 @@ describe('github', () => {
|
||||||
...mockRelease,
|
...mockRelease,
|
||||||
owner,
|
owner,
|
||||||
repo,
|
repo,
|
||||||
tag_name: 'v1.0.1',
|
tag_name: "v1.0.1",
|
||||||
};
|
};
|
||||||
|
|
||||||
const releaser = {
|
const releaser = {
|
||||||
|
@ -72,12 +79,17 @@ describe('github', () => {
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const result = await findTagFromReleases(releaser, owner, repo, targetTag);
|
const result = await findTagFromReleases(
|
||||||
|
releaser,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
targetTag,
|
||||||
|
);
|
||||||
|
|
||||||
assert.deepStrictEqual(result, targetRelease);
|
assert.deepStrictEqual(result, targetRelease);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('finds a matching release in second batch of results', async () => {
|
it("finds a matching release in second batch of results", async () => {
|
||||||
const targetRelease = {
|
const targetRelease = {
|
||||||
...mockRelease,
|
...mockRelease,
|
||||||
owner,
|
owner,
|
||||||
|
@ -88,7 +100,7 @@ describe('github', () => {
|
||||||
...mockRelease,
|
...mockRelease,
|
||||||
owner,
|
owner,
|
||||||
repo,
|
repo,
|
||||||
tag_name: 'v1.0.1',
|
tag_name: "v1.0.1",
|
||||||
};
|
};
|
||||||
|
|
||||||
const releaser = {
|
const releaser = {
|
||||||
|
@ -99,16 +111,21 @@ describe('github', () => {
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const result = await findTagFromReleases(releaser, owner, repo, targetTag);
|
const result = await findTagFromReleases(
|
||||||
|
releaser,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
targetTag,
|
||||||
|
);
|
||||||
assert.deepStrictEqual(result, targetRelease);
|
assert.deepStrictEqual(result, targetRelease);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('returns undefined when a release is not found in any batch', async () => {
|
it("returns undefined when a release is not found in any batch", async () => {
|
||||||
const otherRelease = {
|
const otherRelease = {
|
||||||
...mockRelease,
|
...mockRelease,
|
||||||
owner,
|
owner,
|
||||||
repo,
|
repo,
|
||||||
tag_name: 'v1.0.1',
|
tag_name: "v1.0.1",
|
||||||
};
|
};
|
||||||
const releaser = {
|
const releaser = {
|
||||||
...mockReleaser,
|
...mockReleaser,
|
||||||
|
@ -118,12 +135,17 @@ describe('github', () => {
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const result = await findTagFromReleases(releaser, owner, repo, targetTag);
|
const result = await findTagFromReleases(
|
||||||
|
releaser,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
targetTag,
|
||||||
|
);
|
||||||
|
|
||||||
assert.strictEqual(result, undefined);
|
assert.strictEqual(result, undefined);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('returns undefined when no releases are returned', async () => {
|
it("returns undefined when no releases are returned", async () => {
|
||||||
const releaser = {
|
const releaser = {
|
||||||
...mockReleaser,
|
...mockReleaser,
|
||||||
allReleases: async function* () {
|
allReleases: async function* () {
|
||||||
|
@ -131,16 +153,21 @@ describe('github', () => {
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const result = await findTagFromReleases(releaser, owner, repo, targetTag);
|
const result = await findTagFromReleases(
|
||||||
|
releaser,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
targetTag,
|
||||||
|
);
|
||||||
|
|
||||||
assert.strictEqual(result, undefined);
|
assert.strictEqual(result, undefined);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('when the tag_name is an empty string', () => {
|
describe("when the tag_name is an empty string", () => {
|
||||||
const emptyTag = '';
|
const emptyTag = "";
|
||||||
|
|
||||||
it('finds a matching release in first batch of results', async () => {
|
it("finds a matching release in first batch of results", async () => {
|
||||||
const targetRelease = {
|
const targetRelease = {
|
||||||
...mockRelease,
|
...mockRelease,
|
||||||
owner,
|
owner,
|
||||||
|
@ -151,7 +178,7 @@ describe('github', () => {
|
||||||
...mockRelease,
|
...mockRelease,
|
||||||
owner,
|
owner,
|
||||||
repo,
|
repo,
|
||||||
tag_name: 'v1.0.1',
|
tag_name: "v1.0.1",
|
||||||
};
|
};
|
||||||
|
|
||||||
const releaser = {
|
const releaser = {
|
||||||
|
@ -162,12 +189,17 @@ describe('github', () => {
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
|
const result = await findTagFromReleases(
|
||||||
|
releaser,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
emptyTag,
|
||||||
|
);
|
||||||
|
|
||||||
assert.deepStrictEqual(result, targetRelease);
|
assert.deepStrictEqual(result, targetRelease);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('finds a matching release in second batch of results', async () => {
|
it("finds a matching release in second batch of results", async () => {
|
||||||
const targetRelease = {
|
const targetRelease = {
|
||||||
...mockRelease,
|
...mockRelease,
|
||||||
owner,
|
owner,
|
||||||
|
@ -178,7 +210,7 @@ describe('github', () => {
|
||||||
...mockRelease,
|
...mockRelease,
|
||||||
owner,
|
owner,
|
||||||
repo,
|
repo,
|
||||||
tag_name: 'v1.0.1',
|
tag_name: "v1.0.1",
|
||||||
};
|
};
|
||||||
|
|
||||||
const releaser = {
|
const releaser = {
|
||||||
|
@ -189,16 +221,21 @@ describe('github', () => {
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
|
const result = await findTagFromReleases(
|
||||||
|
releaser,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
emptyTag,
|
||||||
|
);
|
||||||
assert.deepStrictEqual(result, targetRelease);
|
assert.deepStrictEqual(result, targetRelease);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('returns undefined when a release is not found in any batch', async () => {
|
it("returns undefined when a release is not found in any batch", async () => {
|
||||||
const otherRelease = {
|
const otherRelease = {
|
||||||
...mockRelease,
|
...mockRelease,
|
||||||
owner,
|
owner,
|
||||||
repo,
|
repo,
|
||||||
tag_name: 'v1.0.1',
|
tag_name: "v1.0.1",
|
||||||
};
|
};
|
||||||
const releaser = {
|
const releaser = {
|
||||||
...mockReleaser,
|
...mockReleaser,
|
||||||
|
@ -208,12 +245,17 @@ describe('github', () => {
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
|
const result = await findTagFromReleases(
|
||||||
|
releaser,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
emptyTag,
|
||||||
|
);
|
||||||
|
|
||||||
assert.strictEqual(result, undefined);
|
assert.strictEqual(result, undefined);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('returns undefined when no releases are returned', async () => {
|
it("returns undefined when no releases are returned", async () => {
|
||||||
const releaser = {
|
const releaser = {
|
||||||
...mockReleaser,
|
...mockReleaser,
|
||||||
allReleases: async function* () {
|
allReleases: async function* () {
|
||||||
|
@ -221,7 +263,12 @@ describe('github', () => {
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
|
const result = await findTagFromReleases(
|
||||||
|
releaser,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
emptyTag,
|
||||||
|
);
|
||||||
|
|
||||||
assert.strictEqual(result, undefined);
|
assert.strictEqual(result, undefined);
|
||||||
});
|
});
|
||||||
|
|
|
@ -1,60 +1,56 @@
|
||||||
import {
|
import {
|
||||||
alignAssetName,
|
releaseBody,
|
||||||
isTag,
|
isTag,
|
||||||
|
paths,
|
||||||
parseConfig,
|
parseConfig,
|
||||||
parseInputFiles,
|
parseInputFiles,
|
||||||
paths,
|
|
||||||
releaseBody,
|
|
||||||
unmatchedPatterns,
|
unmatchedPatterns,
|
||||||
uploadUrl,
|
uploadUrl,
|
||||||
} from '../src/util';
|
alignAssetName,
|
||||||
|
} from "../src/util";
|
||||||
|
import * as assert from "assert";
|
||||||
|
|
||||||
import { assert, describe, expect, it } from 'vitest';
|
import { describe, it, expect } from "vitest";
|
||||||
|
|
||||||
describe('util', () => {
|
describe("util", () => {
|
||||||
describe('uploadUrl', () => {
|
describe("uploadUrl", () => {
|
||||||
it('strips template', () => {
|
it("strips template", () => {
|
||||||
assert.equal(
|
assert.equal(
|
||||||
uploadUrl(
|
uploadUrl(
|
||||||
'https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}',
|
"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
|
||||||
),
|
),
|
||||||
'https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets',
|
"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets",
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('parseInputFiles', () => {
|
describe("parseInputFiles", () => {
|
||||||
it('parses empty strings', () => {
|
it("parses empty strings", () => {
|
||||||
assert.deepStrictEqual(parseInputFiles(''), []);
|
assert.deepStrictEqual(parseInputFiles(""), []);
|
||||||
});
|
});
|
||||||
it('parses comma-delimited strings', () => {
|
it("parses comma-delimited strings", () => {
|
||||||
assert.deepStrictEqual(parseInputFiles('foo,bar'), ['foo', 'bar']);
|
assert.deepStrictEqual(parseInputFiles("foo,bar"), ["foo", "bar"]);
|
||||||
});
|
});
|
||||||
it('parses newline and comma-delimited (and then some)', () => {
|
it("parses newline and comma-delimited (and then some)", () => {
|
||||||
assert.deepStrictEqual(parseInputFiles('foo,bar\nbaz,boom,\n\ndoom,loom '), [
|
assert.deepStrictEqual(
|
||||||
'foo',
|
parseInputFiles("foo,bar\nbaz,boom,\n\ndoom,loom "),
|
||||||
'bar',
|
["foo", "bar", "baz", "boom", "doom", "loom"],
|
||||||
'baz',
|
);
|
||||||
'boom',
|
|
||||||
'doom',
|
|
||||||
'loom',
|
|
||||||
]);
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('releaseBody', () => {
|
describe("releaseBody", () => {
|
||||||
it('uses input body', () => {
|
it("uses input body", () => {
|
||||||
assert.equal(
|
assert.equal(
|
||||||
'foo',
|
"foo",
|
||||||
releaseBody({
|
releaseBody({
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: '',
|
github_token: "",
|
||||||
input_body: 'foo',
|
input_body: "foo",
|
||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
input_draft: false,
|
input_draft: false,
|
||||||
input_prerelease: false,
|
input_prerelease: false,
|
||||||
input_preserve_order: undefined,
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_target_commitish: undefined,
|
input_target_commitish: undefined,
|
||||||
|
@ -64,20 +60,19 @@ describe('util', () => {
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
it('uses input body path', () => {
|
it("uses input body path", () => {
|
||||||
assert.equal(
|
assert.equal(
|
||||||
'bar',
|
"bar",
|
||||||
releaseBody({
|
releaseBody({
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: '',
|
github_token: "",
|
||||||
input_body: undefined,
|
input_body: undefined,
|
||||||
input_body_path: '__tests__/release.txt',
|
input_body_path: "__tests__/release.txt",
|
||||||
input_draft: false,
|
input_draft: false,
|
||||||
input_prerelease: false,
|
input_prerelease: false,
|
||||||
input_preserve_order: undefined,
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_target_commitish: undefined,
|
input_target_commitish: undefined,
|
||||||
|
@ -87,20 +82,19 @@ describe('util', () => {
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
it('defaults to body path when both body and body path are provided', () => {
|
it("defaults to body path when both body and body path are provided", () => {
|
||||||
assert.equal(
|
assert.equal(
|
||||||
'bar',
|
"bar",
|
||||||
releaseBody({
|
releaseBody({
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: '',
|
github_token: "",
|
||||||
input_body: 'foo',
|
input_body: "foo",
|
||||||
input_body_path: '__tests__/release.txt',
|
input_body_path: "__tests__/release.txt",
|
||||||
input_draft: false,
|
input_draft: false,
|
||||||
input_prerelease: false,
|
input_prerelease: false,
|
||||||
input_preserve_order: undefined,
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_target_commitish: undefined,
|
input_target_commitish: undefined,
|
||||||
|
@ -111,8 +105,8 @@ describe('util', () => {
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('parseConfig', () => {
|
describe("parseConfig", () => {
|
||||||
it('parses basic config', () => {
|
it("parses basic config", () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
parseConfig({
|
parseConfig({
|
||||||
// note: inputs declared in actions.yml, even when declared not required,
|
// note: inputs declared in actions.yml, even when declared not required,
|
||||||
|
@ -121,13 +115,13 @@ describe('util', () => {
|
||||||
// as an empty string !== undefined in terms of what we pass to the api
|
// as an empty string !== undefined in terms of what we pass to the api
|
||||||
// so we cover that in a test case here to ensure undefined values are actually
|
// so we cover that in a test case here to ensure undefined values are actually
|
||||||
// resolved as undefined and not empty strings
|
// resolved as undefined and not empty strings
|
||||||
INPUT_TARGET_COMMITISH: '',
|
INPUT_TARGET_COMMITISH: "",
|
||||||
INPUT_DISCUSSION_CATEGORY_NAME: '',
|
INPUT_DISCUSSION_CATEGORY_NAME: "",
|
||||||
}),
|
}),
|
||||||
{
|
{
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: '',
|
github_token: "",
|
||||||
input_append_body: false,
|
input_append_body: false,
|
||||||
input_body: undefined,
|
input_body: undefined,
|
||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
|
@ -135,7 +129,6 @@ describe('util', () => {
|
||||||
input_prerelease: undefined,
|
input_prerelease: undefined,
|
||||||
input_preserve_order: undefined,
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_fail_on_unmatched_files: false,
|
input_fail_on_unmatched_files: false,
|
||||||
|
@ -147,42 +140,41 @@ describe('util', () => {
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('parses basic config with commitish', () => {
|
it("parses basic config with commitish", () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
parseConfig({
|
parseConfig({
|
||||||
INPUT_TARGET_COMMITISH: 'affa18ef97bc9db20076945705aba8c516139abd',
|
INPUT_TARGET_COMMITISH: "affa18ef97bc9db20076945705aba8c516139abd",
|
||||||
}),
|
}),
|
||||||
{
|
{
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: '',
|
github_token: "",
|
||||||
input_append_body: false,
|
input_append_body: false,
|
||||||
input_body: undefined,
|
input_body: undefined,
|
||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
input_draft: undefined,
|
input_draft: undefined,
|
||||||
input_prerelease: undefined,
|
input_prerelease: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_preserve_order: undefined,
|
input_preserve_order: undefined,
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_fail_on_unmatched_files: false,
|
input_fail_on_unmatched_files: false,
|
||||||
input_target_commitish: 'affa18ef97bc9db20076945705aba8c516139abd',
|
input_target_commitish: "affa18ef97bc9db20076945705aba8c516139abd",
|
||||||
input_discussion_category_name: undefined,
|
input_discussion_category_name: undefined,
|
||||||
input_generate_release_notes: false,
|
input_generate_release_notes: false,
|
||||||
input_make_latest: undefined,
|
input_make_latest: undefined,
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
it('supports discussion category names', () => {
|
it("supports discussion category names", () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
parseConfig({
|
parseConfig({
|
||||||
INPUT_DISCUSSION_CATEGORY_NAME: 'releases',
|
INPUT_DISCUSSION_CATEGORY_NAME: "releases",
|
||||||
}),
|
}),
|
||||||
{
|
{
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: '',
|
github_token: "",
|
||||||
input_append_body: false,
|
input_append_body: false,
|
||||||
input_body: undefined,
|
input_body: undefined,
|
||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
|
@ -191,26 +183,25 @@ describe('util', () => {
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_preserve_order: undefined,
|
input_preserve_order: undefined,
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_fail_on_unmatched_files: false,
|
input_fail_on_unmatched_files: false,
|
||||||
input_target_commitish: undefined,
|
input_target_commitish: undefined,
|
||||||
input_discussion_category_name: 'releases',
|
input_discussion_category_name: "releases",
|
||||||
input_generate_release_notes: false,
|
input_generate_release_notes: false,
|
||||||
input_make_latest: undefined,
|
input_make_latest: undefined,
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('supports generating release notes', () => {
|
it("supports generating release notes", () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
parseConfig({
|
parseConfig({
|
||||||
INPUT_GENERATE_RELEASE_NOTES: 'true',
|
INPUT_GENERATE_RELEASE_NOTES: "true",
|
||||||
}),
|
}),
|
||||||
{
|
{
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: '',
|
github_token: "",
|
||||||
input_append_body: false,
|
input_append_body: false,
|
||||||
input_body: undefined,
|
input_body: undefined,
|
||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
|
@ -218,7 +209,6 @@ describe('util', () => {
|
||||||
input_prerelease: undefined,
|
input_prerelease: undefined,
|
||||||
input_preserve_order: undefined,
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_fail_on_unmatched_files: false,
|
input_fail_on_unmatched_files: false,
|
||||||
|
@ -230,19 +220,19 @@ describe('util', () => {
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('prefers GITHUB_TOKEN over token input for backwards compatibility', () => {
|
it("prefers GITHUB_TOKEN over token input for backwards compatibility", () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
parseConfig({
|
parseConfig({
|
||||||
INPUT_DRAFT: 'false',
|
INPUT_DRAFT: "false",
|
||||||
INPUT_PRERELEASE: 'true',
|
INPUT_PRERELEASE: "true",
|
||||||
INPUT_PRESERVE_ORDER: 'true',
|
INPUT_PRESERVE_ORDER: "true",
|
||||||
GITHUB_TOKEN: 'env-token',
|
GITHUB_TOKEN: "env-token",
|
||||||
INPUT_TOKEN: 'input-token',
|
INPUT_TOKEN: "input-token",
|
||||||
}),
|
}),
|
||||||
{
|
{
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: 'env-token',
|
github_token: "env-token",
|
||||||
input_append_body: false,
|
input_append_body: false,
|
||||||
input_body: undefined,
|
input_body: undefined,
|
||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
|
@ -250,7 +240,6 @@ describe('util', () => {
|
||||||
input_prerelease: true,
|
input_prerelease: true,
|
||||||
input_preserve_order: true,
|
input_preserve_order: true,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_fail_on_unmatched_files: false,
|
input_fail_on_unmatched_files: false,
|
||||||
|
@ -261,17 +250,17 @@ describe('util', () => {
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
it('uses input token as the source of GITHUB_TOKEN by default', () => {
|
it("uses input token as the source of GITHUB_TOKEN by default", () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
parseConfig({
|
parseConfig({
|
||||||
INPUT_DRAFT: 'false',
|
INPUT_DRAFT: "false",
|
||||||
INPUT_PRERELEASE: 'true',
|
INPUT_PRERELEASE: "true",
|
||||||
INPUT_TOKEN: 'input-token',
|
INPUT_TOKEN: "input-token",
|
||||||
}),
|
}),
|
||||||
{
|
{
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: 'input-token',
|
github_token: "input-token",
|
||||||
input_append_body: false,
|
input_append_body: false,
|
||||||
input_body: undefined,
|
input_body: undefined,
|
||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
|
@ -279,7 +268,6 @@ describe('util', () => {
|
||||||
input_prerelease: true,
|
input_prerelease: true,
|
||||||
input_preserve_order: undefined,
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_fail_on_unmatched_files: false,
|
input_fail_on_unmatched_files: false,
|
||||||
|
@ -290,16 +278,16 @@ describe('util', () => {
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
it('parses basic config with draft and prerelease', () => {
|
it("parses basic config with draft and prerelease", () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
parseConfig({
|
parseConfig({
|
||||||
INPUT_DRAFT: 'false',
|
INPUT_DRAFT: "false",
|
||||||
INPUT_PRERELEASE: 'true',
|
INPUT_PRERELEASE: "true",
|
||||||
}),
|
}),
|
||||||
{
|
{
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: '',
|
github_token: "",
|
||||||
input_append_body: false,
|
input_append_body: false,
|
||||||
input_body: undefined,
|
input_body: undefined,
|
||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
|
@ -307,7 +295,6 @@ describe('util', () => {
|
||||||
input_prerelease: true,
|
input_prerelease: true,
|
||||||
input_preserve_order: undefined,
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_fail_on_unmatched_files: false,
|
input_fail_on_unmatched_files: false,
|
||||||
|
@ -318,15 +305,15 @@ describe('util', () => {
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
it('parses basic config where make_latest is passed', () => {
|
it("parses basic config where make_latest is passed", () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
parseConfig({
|
parseConfig({
|
||||||
INPUT_MAKE_LATEST: 'false',
|
INPUT_MAKE_LATEST: "false",
|
||||||
}),
|
}),
|
||||||
{
|
{
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: '',
|
github_token: "",
|
||||||
input_append_body: false,
|
input_append_body: false,
|
||||||
input_body: undefined,
|
input_body: undefined,
|
||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
|
@ -335,25 +322,24 @@ describe('util', () => {
|
||||||
input_preserve_order: undefined,
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_fail_on_unmatched_files: false,
|
input_fail_on_unmatched_files: false,
|
||||||
input_target_commitish: undefined,
|
input_target_commitish: undefined,
|
||||||
input_discussion_category_name: undefined,
|
input_discussion_category_name: undefined,
|
||||||
input_generate_release_notes: false,
|
input_generate_release_notes: false,
|
||||||
input_make_latest: 'false',
|
input_make_latest: "false",
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
it('parses basic config with append_body', () => {
|
it("parses basic config with append_body", () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
parseConfig({
|
parseConfig({
|
||||||
INPUT_APPEND_BODY: 'true',
|
INPUT_APPEND_BODY: "true",
|
||||||
}),
|
}),
|
||||||
{
|
{
|
||||||
github_ref: '',
|
github_ref: "",
|
||||||
github_repository: '',
|
github_repository: "",
|
||||||
github_token: '',
|
github_token: "",
|
||||||
input_append_body: true,
|
input_append_body: true,
|
||||||
input_body: undefined,
|
input_body: undefined,
|
||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
|
@ -361,7 +347,6 @@ describe('util', () => {
|
||||||
input_prerelease: undefined,
|
input_prerelease: undefined,
|
||||||
input_preserve_order: undefined,
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_overwrite_files: undefined,
|
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
input_fail_on_unmatched_files: false,
|
input_fail_on_unmatched_files: false,
|
||||||
|
@ -373,43 +358,46 @@ describe('util', () => {
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
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);
|
||||||
});
|
});
|
||||||
it('returns false for other kinds of refs', async () => {
|
it("returns false for other kinds of refs", async () => {
|
||||||
assert.equal(isTag('refs/heads/master'), false);
|
assert.equal(isTag("refs/heads/master"), false);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('paths', () => {
|
describe("paths", () => {
|
||||||
it('resolves files given a set of paths', async () => {
|
it("resolves files given a set of paths", async () => {
|
||||||
assert.deepStrictEqual(paths(['tests/data/**/*', 'tests/data/does/not/exist/*']), [
|
|
||||||
'tests/data/foo/bar.txt',
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('unmatchedPatterns', () => {
|
|
||||||
it("returns the patterns that don't match any files", async () => {
|
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
unmatchedPatterns(['tests/data/**/*', 'tests/data/does/not/exist/*']),
|
paths(["tests/data/**/*", "tests/data/does/not/exist/*"]),
|
||||||
['tests/data/does/not/exist/*'],
|
["tests/data/foo/bar.txt"],
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('replaceSpacesWithDots', () => {
|
describe("unmatchedPatterns", () => {
|
||||||
it('replaces all spaces with dots', () => {
|
it("returns the patterns that don't match any files", async () => {
|
||||||
expect(alignAssetName('John Doe.bla')).toBe('John.Doe.bla');
|
assert.deepStrictEqual(
|
||||||
|
unmatchedPatterns(["tests/data/**/*", "tests/data/does/not/exist/*"]),
|
||||||
|
["tests/data/does/not/exist/*"],
|
||||||
|
);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
it('handles names with multiple spaces', () => {
|
describe("replaceSpacesWithDots", () => {
|
||||||
expect(alignAssetName('John William Doe.bla')).toBe('John.William.Doe.bla');
|
it("replaces all spaces with dots", () => {
|
||||||
|
expect(alignAssetName("John Doe.bla")).toBe("John.Doe.bla");
|
||||||
});
|
});
|
||||||
|
|
||||||
it('returns the same string if there are no spaces', () => {
|
it("handles names with multiple spaces", () => {
|
||||||
expect(alignAssetName('JohnDoe')).toBe('JohnDoe');
|
expect(alignAssetName("John William Doe.bla")).toBe(
|
||||||
|
"John.William.Doe.bla",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns the same string if there are no spaces", () => {
|
||||||
|
expect(alignAssetName("JohnDoe")).toBe("JohnDoe");
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
|
@ -27,10 +27,6 @@ inputs:
|
||||||
files:
|
files:
|
||||||
description: "Newline-delimited list of path globs for asset files to upload"
|
description: "Newline-delimited list of path globs for asset files to upload"
|
||||||
required: false
|
required: false
|
||||||
overwrite_files:
|
|
||||||
description: "Overwrite existing files with the same name. Defaults to true"
|
|
||||||
required: false
|
|
||||||
default: 'true'
|
|
||||||
fail_on_unmatched_files:
|
fail_on_unmatched_files:
|
||||||
description: "Fails if any of the `files` globs match nothing. Defaults to false"
|
description: "Fails if any of the `files` globs match nothing. Defaults to false"
|
||||||
required: false
|
required: false
|
||||||
|
|
2
dist/index.js
vendored
2
dist/index.js
vendored
File diff suppressed because one or more lines are too long
87
package-lock.json
generated
87
package-lock.json
generated
|
@ -1,24 +1,24 @@
|
||||||
{
|
{
|
||||||
"name": "action-gh-release",
|
"name": "action-gh-release",
|
||||||
"version": "2.3.2",
|
"version": "2.2.2",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "action-gh-release",
|
"name": "action-gh-release",
|
||||||
"version": "2.3.2",
|
"version": "2.2.2",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": "^1.11.1",
|
"@actions/core": "^1.11.1",
|
||||||
"@actions/github": "^6.0.1",
|
"@actions/github": "^6.0.1",
|
||||||
"@octokit/plugin-retry": "^8.0.1",
|
"@octokit/plugin-retry": "^8.0.1",
|
||||||
"@octokit/plugin-throttling": "^11.0.1",
|
"@octokit/plugin-throttling": "^11.0.1",
|
||||||
"glob": "^11.0.3",
|
"glob": "^11.0.2",
|
||||||
"mime-types": "^3.0.1"
|
"mime-types": "^3.0.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/glob": "^8.1.0",
|
"@types/glob": "^8.1.0",
|
||||||
"@types/mime-types": "^3.0.1",
|
"@types/mime-types": "^3.0.1",
|
||||||
"@types/node": "^20.19.1",
|
"@types/node": "^22.15.21",
|
||||||
"@vercel/ncc": "^0.38.3",
|
"@vercel/ncc": "^0.38.3",
|
||||||
"@vitest/coverage-v8": "^3.1.4",
|
"@vitest/coverage-v8": "^3.1.4",
|
||||||
"prettier": "3.5.3",
|
"prettier": "3.5.3",
|
||||||
|
@ -723,27 +723,6 @@
|
||||||
"node": ">=14"
|
"node": ">=14"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@isaacs/balanced-match": {
|
|
||||||
"version": "4.0.1",
|
|
||||||
"resolved": "https://registry.npmjs.org/@isaacs/balanced-match/-/balanced-match-4.0.1.tgz",
|
|
||||||
"integrity": "sha512-yzMTt9lEb8Gv7zRioUilSglI0c0smZ9k5D65677DLWLtWJaXIS3CqcGyUFByYKlnUj6TkjLVs54fBl6+TiGQDQ==",
|
|
||||||
"license": "MIT",
|
|
||||||
"engines": {
|
|
||||||
"node": "20 || >=22"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/@isaacs/brace-expansion": {
|
|
||||||
"version": "5.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/@isaacs/brace-expansion/-/brace-expansion-5.0.0.tgz",
|
|
||||||
"integrity": "sha512-ZT55BDLV0yv0RBm2czMiZ+SqCGO7AvmOM3G/w2xhVPH+te0aKgFjmBvGlL1dH+ql2tgGO3MVrbb3jCKyvpgnxA==",
|
|
||||||
"license": "MIT",
|
|
||||||
"dependencies": {
|
|
||||||
"@isaacs/balanced-match": "^4.0.1"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": "20 || >=22"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/@isaacs/cliui": {
|
"node_modules/@isaacs/cliui": {
|
||||||
"version": "8.0.2",
|
"version": "8.0.2",
|
||||||
"resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz",
|
"resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz",
|
||||||
|
@ -1176,7 +1155,6 @@
|
||||||
"version": "0.11.0",
|
"version": "0.11.0",
|
||||||
"resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz",
|
"resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz",
|
||||||
"integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==",
|
"integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==",
|
||||||
"dev": true,
|
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=14"
|
"node": ">=14"
|
||||||
|
@ -1534,9 +1512,9 @@
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"node_modules/@types/node": {
|
"node_modules/@types/node": {
|
||||||
"version": "20.19.1",
|
"version": "22.15.21",
|
||||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.1.tgz",
|
"resolved": "https://registry.npmjs.org/@types/node/-/node-22.15.21.tgz",
|
||||||
"integrity": "sha512-jJD50LtlD2dodAEO653i3YF04NWak6jN3ky+Ri3Em3mGR39/glWiboM/IePaRbgwSfqM1TpGXfAg8ohn/4dTgA==",
|
"integrity": "sha512-EV/37Td6c+MgKAbkcLG6vqZ2zEYHD7bvSrzqqs2RIhbA6w3x+Dqz8MZM3sP6kGTeLrdoOgKZe+Xja7tUB2DNkQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
@ -1902,8 +1880,7 @@
|
||||||
"node_modules/balanced-match": {
|
"node_modules/balanced-match": {
|
||||||
"version": "1.0.2",
|
"version": "1.0.2",
|
||||||
"resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
|
"resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
|
||||||
"integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==",
|
"integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="
|
||||||
"dev": true
|
|
||||||
},
|
},
|
||||||
"node_modules/before-after-hook": {
|
"node_modules/before-after-hook": {
|
||||||
"version": "2.2.3",
|
"version": "2.2.3",
|
||||||
|
@ -1916,11 +1893,9 @@
|
||||||
"integrity": "sha512-VHiNCbI1lKdl44tGrhNfU3lup0Tj/ZBMJB5/2ZbNXRCPuRCO7ed2mgcK4r17y+KB2EfuYuRaVlwNbAeaWGSpbw=="
|
"integrity": "sha512-VHiNCbI1lKdl44tGrhNfU3lup0Tj/ZBMJB5/2ZbNXRCPuRCO7ed2mgcK4r17y+KB2EfuYuRaVlwNbAeaWGSpbw=="
|
||||||
},
|
},
|
||||||
"node_modules/brace-expansion": {
|
"node_modules/brace-expansion": {
|
||||||
"version": "2.0.2",
|
"version": "2.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz",
|
"resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz",
|
||||||
"integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==",
|
"integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
|
||||||
"dev": true,
|
|
||||||
"license": "MIT",
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"balanced-match": "^1.0.0"
|
"balanced-match": "^1.0.0"
|
||||||
}
|
}
|
||||||
|
@ -2187,12 +2162,11 @@
|
||||||
"peer": true
|
"peer": true
|
||||||
},
|
},
|
||||||
"node_modules/foreground-child": {
|
"node_modules/foreground-child": {
|
||||||
"version": "3.3.1",
|
"version": "3.2.1",
|
||||||
"resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.3.1.tgz",
|
"resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.2.1.tgz",
|
||||||
"integrity": "sha512-gIXjKqtFuWEgzFRJA9WCQeSJLZDjgJUOMCMzxtvFq/37KojM1BFGufqsCy0r4qSQmYLsZYMeyRqzIWOMup03sw==",
|
"integrity": "sha512-PXUUyLqrR2XCWICfv6ukppP96sdFwWbNEnfEMt7jNsISjMsvaLNinAHNDYyvkyU+SZG2BTSbT5NjG+vZslfGTA==",
|
||||||
"license": "ISC",
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"cross-spawn": "^7.0.6",
|
"cross-spawn": "^7.0.0",
|
||||||
"signal-exit": "^4.0.1"
|
"signal-exit": "^4.0.1"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
|
@ -2228,14 +2202,14 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/glob": {
|
"node_modules/glob": {
|
||||||
"version": "11.0.3",
|
"version": "11.0.2",
|
||||||
"resolved": "https://registry.npmjs.org/glob/-/glob-11.0.3.tgz",
|
"resolved": "https://registry.npmjs.org/glob/-/glob-11.0.2.tgz",
|
||||||
"integrity": "sha512-2Nim7dha1KVkaiF4q6Dj+ngPPMdfvLJEOpZk/jKiUAkqKebpGAWQXAq9z1xu9HKu5lWfqw/FASuccEjyznjPaA==",
|
"integrity": "sha512-YT7U7Vye+t5fZ/QMkBFrTJ7ZQxInIUjwyAjVj84CYXqgBdv30MFUPGnBR6sQaVq6Is15wYJUsnzTuWaGRBhBAQ==",
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"foreground-child": "^3.3.1",
|
"foreground-child": "^3.1.0",
|
||||||
"jackspeak": "^4.1.1",
|
"jackspeak": "^4.0.1",
|
||||||
"minimatch": "^10.0.3",
|
"minimatch": "^10.0.0",
|
||||||
"minipass": "^7.1.2",
|
"minipass": "^7.1.2",
|
||||||
"package-json-from-dist": "^1.0.0",
|
"package-json-from-dist": "^1.0.0",
|
||||||
"path-scurry": "^2.0.0"
|
"path-scurry": "^2.0.0"
|
||||||
|
@ -2315,10 +2289,9 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/jackspeak": {
|
"node_modules/jackspeak": {
|
||||||
"version": "4.1.1",
|
"version": "4.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-4.1.1.tgz",
|
"resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-4.0.1.tgz",
|
||||||
"integrity": "sha512-zptv57P3GpL+O0I7VdMJNBZCu+BPHVQUk55Ft8/QCJjTVxrnJHuVuX/0Bl2A6/+2oyR/ZMEuFKwmzqqZ/U5nPQ==",
|
"integrity": "sha512-cub8rahkh0Q/bw1+GxP7aeSe29hHHn2V4m29nnDlvCdlgU+3UGxkZp7Z53jLUdpX3jdTO0nJZUDl3xvbWc2Xog==",
|
||||||
"license": "BlueOak-1.0.0",
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@isaacs/cliui": "^8.0.2"
|
"@isaacs/cliui": "^8.0.2"
|
||||||
},
|
},
|
||||||
|
@ -2327,6 +2300,9 @@
|
||||||
},
|
},
|
||||||
"funding": {
|
"funding": {
|
||||||
"url": "https://github.com/sponsors/isaacs"
|
"url": "https://github.com/sponsors/isaacs"
|
||||||
|
},
|
||||||
|
"optionalDependencies": {
|
||||||
|
"@pkgjs/parseargs": "^0.11.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/loupe": {
|
"node_modules/loupe": {
|
||||||
|
@ -2413,12 +2389,11 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/minimatch": {
|
"node_modules/minimatch": {
|
||||||
"version": "10.0.3",
|
"version": "10.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.0.3.tgz",
|
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.0.1.tgz",
|
||||||
"integrity": "sha512-IPZ167aShDZZUMdRk66cyQAW3qr0WzbHkPdMYa8bzZhlHhO3jALbKdxcaak7W9FfT2rZNpQuUu4Od7ILEpXSaw==",
|
"integrity": "sha512-ethXTt3SGGR+95gudmqJ1eNhRO7eGEGIgYA9vnPatK4/etz2MEVDno5GMCibdMTuBMyElzIlgxMna3K94XDIDQ==",
|
||||||
"license": "ISC",
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@isaacs/brace-expansion": "^5.0.0"
|
"brace-expansion": "^2.0.1"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": "20 || >=22"
|
"node": "20 || >=22"
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "action-gh-release",
|
"name": "action-gh-release",
|
||||||
"version": "2.3.2",
|
"version": "2.3.1",
|
||||||
"private": true,
|
"private": true,
|
||||||
"description": "GitHub Action for creating GitHub Releases",
|
"description": "GitHub Action for creating GitHub Releases",
|
||||||
"main": "lib/main.js",
|
"main": "lib/main.js",
|
||||||
|
@ -26,13 +26,13 @@
|
||||||
"@actions/github": "^6.0.1",
|
"@actions/github": "^6.0.1",
|
||||||
"@octokit/plugin-retry": "^8.0.1",
|
"@octokit/plugin-retry": "^8.0.1",
|
||||||
"@octokit/plugin-throttling": "^11.0.1",
|
"@octokit/plugin-throttling": "^11.0.1",
|
||||||
"glob": "^11.0.3",
|
"glob": "^11.0.2",
|
||||||
"mime-types": "^3.0.1"
|
"mime-types": "^3.0.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/glob": "^8.1.0",
|
"@types/glob": "^8.1.0",
|
||||||
"@types/mime-types": "^3.0.1",
|
"@types/mime-types": "^3.0.1",
|
||||||
"@types/node": "^20.19.1",
|
"@types/node": "^22.15.21",
|
||||||
"@vercel/ncc": "^0.38.3",
|
"@vercel/ncc": "^0.38.3",
|
||||||
"@vitest/coverage-v8": "^3.1.4",
|
"@vitest/coverage-v8": "^3.1.4",
|
||||||
"prettier": "3.5.3",
|
"prettier": "3.5.3",
|
||||||
|
|
112
src/github.ts
112
src/github.ts
|
@ -1,9 +1,9 @@
|
||||||
import { GitHub } from '@actions/github/lib/utils';
|
import { GitHub } from "@actions/github/lib/utils";
|
||||||
import { statSync } from 'fs';
|
import { Config, isTag, releaseBody, alignAssetName } from "./util";
|
||||||
import { open } from 'fs/promises';
|
import { statSync } from "fs";
|
||||||
import { lookup } from 'mime-types';
|
import { open } from "fs/promises";
|
||||||
import { basename } from 'path';
|
import { lookup } from "mime-types";
|
||||||
import { alignAssetName, Config, isTag, releaseBody } from './util';
|
import { basename } from "path";
|
||||||
|
|
||||||
type GitHub = InstanceType<typeof GitHub>;
|
type GitHub = InstanceType<typeof GitHub>;
|
||||||
|
|
||||||
|
@ -27,7 +27,11 @@ export interface Release {
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface Releaser {
|
export interface Releaser {
|
||||||
getReleaseByTag(params: { owner: string; repo: string; tag: string }): Promise<{ data: Release }>;
|
getReleaseByTag(params: {
|
||||||
|
owner: string;
|
||||||
|
repo: string;
|
||||||
|
tag: string;
|
||||||
|
}): Promise<{ data: Release }>;
|
||||||
|
|
||||||
createRelease(params: {
|
createRelease(params: {
|
||||||
owner: string;
|
owner: string;
|
||||||
|
@ -40,7 +44,7 @@ export interface Releaser {
|
||||||
target_commitish: string | undefined;
|
target_commitish: string | undefined;
|
||||||
discussion_category_name: string | undefined;
|
discussion_category_name: string | undefined;
|
||||||
generate_release_notes: boolean | undefined;
|
generate_release_notes: boolean | undefined;
|
||||||
make_latest: 'true' | 'false' | 'legacy' | undefined;
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
}): Promise<{ data: Release }>;
|
}): Promise<{ data: Release }>;
|
||||||
|
|
||||||
updateRelease(params: {
|
updateRelease(params: {
|
||||||
|
@ -55,10 +59,13 @@ export interface Releaser {
|
||||||
prerelease: boolean | undefined;
|
prerelease: boolean | undefined;
|
||||||
discussion_category_name: string | undefined;
|
discussion_category_name: string | undefined;
|
||||||
generate_release_notes: boolean | undefined;
|
generate_release_notes: boolean | undefined;
|
||||||
make_latest: 'true' | 'false' | 'legacy' | undefined;
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
}): Promise<{ data: Release }>;
|
}): Promise<{ data: Release }>;
|
||||||
|
|
||||||
allReleases(params: { owner: string; repo: string }): AsyncIterableIterator<{ data: Release[] }>;
|
allReleases(params: {
|
||||||
|
owner: string;
|
||||||
|
repo: string;
|
||||||
|
}): AsyncIterableIterator<{ data: Release[] }>;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class GitHubReleaser implements Releaser {
|
export class GitHubReleaser implements Releaser {
|
||||||
|
@ -86,11 +93,11 @@ export class GitHubReleaser implements Releaser {
|
||||||
target_commitish: string | undefined;
|
target_commitish: string | undefined;
|
||||||
discussion_category_name: string | undefined;
|
discussion_category_name: string | undefined;
|
||||||
generate_release_notes: boolean | undefined;
|
generate_release_notes: boolean | undefined;
|
||||||
make_latest: 'true' | 'false' | 'legacy' | undefined;
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
}): Promise<{ data: Release }> {
|
}): Promise<{ data: Release }> {
|
||||||
if (
|
if (
|
||||||
typeof params.make_latest === 'string' &&
|
typeof params.make_latest === "string" &&
|
||||||
!['true', 'false', 'legacy'].includes(params.make_latest)
|
!["true", "false", "legacy"].includes(params.make_latest)
|
||||||
) {
|
) {
|
||||||
params.make_latest = undefined;
|
params.make_latest = undefined;
|
||||||
}
|
}
|
||||||
|
@ -110,11 +117,11 @@ export class GitHubReleaser implements Releaser {
|
||||||
prerelease: boolean | undefined;
|
prerelease: boolean | undefined;
|
||||||
discussion_category_name: string | undefined;
|
discussion_category_name: string | undefined;
|
||||||
generate_release_notes: boolean | undefined;
|
generate_release_notes: boolean | undefined;
|
||||||
make_latest: 'true' | 'false' | 'legacy' | undefined;
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
}): Promise<{ data: Release }> {
|
}): Promise<{ data: Release }> {
|
||||||
if (
|
if (
|
||||||
typeof params.make_latest === 'string' &&
|
typeof params.make_latest === "string" &&
|
||||||
!['true', 'false', 'legacy'].includes(params.make_latest)
|
!["true", "false", "legacy"].includes(params.make_latest)
|
||||||
) {
|
) {
|
||||||
params.make_latest = undefined;
|
params.make_latest = undefined;
|
||||||
}
|
}
|
||||||
|
@ -122,7 +129,10 @@ export class GitHubReleaser implements Releaser {
|
||||||
return this.github.rest.repos.updateRelease(params);
|
return this.github.rest.repos.updateRelease(params);
|
||||||
}
|
}
|
||||||
|
|
||||||
allReleases(params: { owner: string; repo: string }): AsyncIterableIterator<{ data: Release[] }> {
|
allReleases(params: {
|
||||||
|
owner: string;
|
||||||
|
repo: string;
|
||||||
|
}): AsyncIterableIterator<{ data: Release[] }> {
|
||||||
const updatedParams = { per_page: 100, ...params };
|
const updatedParams = { per_page: 100, ...params };
|
||||||
return this.github.paginate.iterator(
|
return this.github.paginate.iterator(
|
||||||
this.github.rest.repos.listReleases.endpoint.merge(updatedParams),
|
this.github.rest.repos.listReleases.endpoint.merge(updatedParams),
|
||||||
|
@ -139,7 +149,7 @@ export const asset = (path: string): ReleaseAsset => {
|
||||||
};
|
};
|
||||||
|
|
||||||
export const mimeOrDefault = (path: string): string => {
|
export const mimeOrDefault = (path: string): string => {
|
||||||
return lookup(path) || 'application/octet-stream';
|
return lookup(path) || "application/octet-stream";
|
||||||
};
|
};
|
||||||
|
|
||||||
export const upload = async (
|
export const upload = async (
|
||||||
|
@ -149,7 +159,7 @@ export const upload = async (
|
||||||
path: string,
|
path: string,
|
||||||
currentAssets: Array<{ id: number; name: string }>,
|
currentAssets: Array<{ id: number; name: string }>,
|
||||||
): Promise<any> => {
|
): Promise<any> => {
|
||||||
const [owner, repo] = config.github_repository.split('/');
|
const [owner, repo] = config.github_repository.split("/");
|
||||||
const { name, mime, size } = asset(path);
|
const { name, mime, size } = asset(path);
|
||||||
const currentAsset = currentAssets.find(
|
const currentAsset = currentAssets.find(
|
||||||
// note: GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "List release assets" endpoint lists the renamed filenames.
|
// note: GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "List release assets" endpoint lists the renamed filenames.
|
||||||
|
@ -158,10 +168,6 @@ export const upload = async (
|
||||||
({ name: currentName }) => currentName == alignAssetName(name),
|
({ name: currentName }) => currentName == alignAssetName(name),
|
||||||
);
|
);
|
||||||
if (currentAsset) {
|
if (currentAsset) {
|
||||||
if (config.input_overwrite_files === false) {
|
|
||||||
console.log(`Asset ${name} already exists and overwrite_files is false...`);
|
|
||||||
return null;
|
|
||||||
} else {
|
|
||||||
console.log(`♻️ Deleting previously uploaded asset ${name}...`);
|
console.log(`♻️ Deleting previously uploaded asset ${name}...`);
|
||||||
await github.rest.repos.deleteReleaseAsset({
|
await github.rest.repos.deleteReleaseAsset({
|
||||||
asset_id: currentAsset.id || 1,
|
asset_id: currentAsset.id || 1,
|
||||||
|
@ -169,21 +175,21 @@ export const upload = async (
|
||||||
repo,
|
repo,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
|
||||||
console.log(`⬆️ Uploading ${name}...`);
|
console.log(`⬆️ Uploading ${name}...`);
|
||||||
const endpoint = new URL(url);
|
const endpoint = new URL(url);
|
||||||
endpoint.searchParams.append('name', name);
|
endpoint.searchParams.append("name", name);
|
||||||
const fh = await open(path);
|
const fh = await open(path);
|
||||||
try {
|
try {
|
||||||
|
const stream = fh.readableWebStream();
|
||||||
const resp = await github.request({
|
const resp = await github.request({
|
||||||
method: 'POST',
|
method: "POST",
|
||||||
url: endpoint.toString(),
|
url: endpoint.toString(),
|
||||||
headers: {
|
headers: {
|
||||||
'content-length': `${size}`,
|
"content-length": `${size}`,
|
||||||
'content-type': mime,
|
"content-type": mime,
|
||||||
authorization: `token ${config.github_token}`,
|
authorization: `token ${config.github_token}`,
|
||||||
},
|
},
|
||||||
data: fh.readableWebStream({ type: 'bytes' }),
|
data: stream,
|
||||||
});
|
});
|
||||||
const json = resp.data;
|
const json = resp.data;
|
||||||
if (resp.status !== 201) {
|
if (resp.status !== 201) {
|
||||||
|
@ -196,7 +202,7 @@ export const upload = async (
|
||||||
console.log(`✅ Uploaded ${name}`);
|
console.log(`✅ Uploaded ${name}`);
|
||||||
return json;
|
return json;
|
||||||
} finally {
|
} finally {
|
||||||
await fh.close();
|
await fh.close().catch(() => {});
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -207,18 +213,25 @@ export const release = async (
|
||||||
): Promise<Release> => {
|
): Promise<Release> => {
|
||||||
if (maxRetries <= 0) {
|
if (maxRetries <= 0) {
|
||||||
console.log(`❌ Too many retries. Aborting...`);
|
console.log(`❌ Too many retries. Aborting...`);
|
||||||
throw new Error('Too many retries.');
|
throw new Error("Too many retries.");
|
||||||
}
|
}
|
||||||
|
|
||||||
const [owner, repo] = config.github_repository.split('/');
|
const [owner, repo] = config.github_repository.split("/");
|
||||||
const tag =
|
const tag =
|
||||||
config.input_tag_name ||
|
config.input_tag_name ||
|
||||||
(isTag(config.github_ref) ? config.github_ref.replace('refs/tags/', '') : '');
|
(isTag(config.github_ref)
|
||||||
|
? config.github_ref.replace("refs/tags/", "")
|
||||||
|
: "");
|
||||||
|
|
||||||
const discussion_category_name = config.input_discussion_category_name;
|
const discussion_category_name = config.input_discussion_category_name;
|
||||||
const generate_release_notes = config.input_generate_release_notes;
|
const generate_release_notes = config.input_generate_release_notes;
|
||||||
try {
|
try {
|
||||||
const _release: Release | undefined = await findTagFromReleases(releaser, owner, repo, tag);
|
const _release: Release | undefined = await findTagFromReleases(
|
||||||
|
releaser,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
tag,
|
||||||
|
);
|
||||||
|
|
||||||
if (_release === undefined) {
|
if (_release === undefined) {
|
||||||
return await createRelease(
|
return await createRelease(
|
||||||
|
@ -234,7 +247,9 @@ export const release = async (
|
||||||
}
|
}
|
||||||
|
|
||||||
let existingRelease: Release = _release!;
|
let existingRelease: Release = _release!;
|
||||||
console.log(`Found release ${existingRelease.name} (with id=${existingRelease.id})`);
|
console.log(
|
||||||
|
`Found release ${existingRelease.name} (with id=${existingRelease.id})`,
|
||||||
|
);
|
||||||
|
|
||||||
const release_id = existingRelease.id;
|
const release_id = existingRelease.id;
|
||||||
let target_commitish: string;
|
let target_commitish: string;
|
||||||
|
@ -256,18 +271,23 @@ export const release = async (
|
||||||
// body parts as a release gets updated. some users will likely want this while
|
// body parts as a release gets updated. some users will likely want this while
|
||||||
// others won't previously this was duplicating content for most which
|
// others won't previously this was duplicating content for most which
|
||||||
// no one wants
|
// no one wants
|
||||||
const workflowBody = releaseBody(config) || '';
|
const workflowBody = releaseBody(config) || "";
|
||||||
const existingReleaseBody = existingRelease.body || '';
|
const existingReleaseBody = existingRelease.body || "";
|
||||||
let body: string;
|
let body: string;
|
||||||
if (config.input_append_body && workflowBody && existingReleaseBody) {
|
if (config.input_append_body && workflowBody && existingReleaseBody) {
|
||||||
body = existingReleaseBody + '\n' + workflowBody;
|
body = existingReleaseBody + "\n" + workflowBody;
|
||||||
} else {
|
} else {
|
||||||
body = workflowBody || existingReleaseBody;
|
body = workflowBody || existingReleaseBody;
|
||||||
}
|
}
|
||||||
|
|
||||||
const draft = config.input_draft !== undefined ? config.input_draft : existingRelease.draft;
|
const draft =
|
||||||
|
config.input_draft !== undefined
|
||||||
|
? config.input_draft
|
||||||
|
: existingRelease.draft;
|
||||||
const prerelease =
|
const prerelease =
|
||||||
config.input_prerelease !== undefined ? config.input_prerelease : existingRelease.prerelease;
|
config.input_prerelease !== undefined
|
||||||
|
? config.input_prerelease
|
||||||
|
: existingRelease.prerelease;
|
||||||
|
|
||||||
const make_latest = config.input_make_latest;
|
const make_latest = config.input_make_latest;
|
||||||
|
|
||||||
|
@ -351,11 +371,13 @@ async function createRelease(
|
||||||
const prerelease = config.input_prerelease;
|
const prerelease = config.input_prerelease;
|
||||||
const target_commitish = config.input_target_commitish;
|
const target_commitish = config.input_target_commitish;
|
||||||
const make_latest = config.input_make_latest;
|
const make_latest = config.input_make_latest;
|
||||||
let commitMessage: string = '';
|
let commitMessage: string = "";
|
||||||
if (target_commitish) {
|
if (target_commitish) {
|
||||||
commitMessage = ` using commit "${target_commitish}"`;
|
commitMessage = ` using commit "${target_commitish}"`;
|
||||||
}
|
}
|
||||||
console.log(`👩🏭 Creating new GitHub release for tag ${tag_name}${commitMessage}...`);
|
console.log(
|
||||||
|
`👩🏭 Creating new GitHub release for tag ${tag_name}${commitMessage}...`,
|
||||||
|
);
|
||||||
try {
|
try {
|
||||||
let release = await releaser.createRelease({
|
let release = await releaser.createRelease({
|
||||||
owner,
|
owner,
|
||||||
|
@ -379,16 +401,16 @@ async function createRelease(
|
||||||
switch (error.status) {
|
switch (error.status) {
|
||||||
case 403:
|
case 403:
|
||||||
console.log(
|
console.log(
|
||||||
'Skip retry — your GitHub token/PAT does not have the required permission to create a release',
|
"Skip retry — your GitHub token/PAT does not have the required permission to create a release",
|
||||||
);
|
);
|
||||||
throw error;
|
throw error;
|
||||||
|
|
||||||
case 404:
|
case 404:
|
||||||
console.log('Skip retry - discussion category mismatch');
|
console.log("Skip retry - discussion category mismatch");
|
||||||
throw error;
|
throw error;
|
||||||
|
|
||||||
case 422:
|
case 422:
|
||||||
console.log('Skip retry - validation failed');
|
console.log("Skip retry - validation failed");
|
||||||
throw error;
|
throw error;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
66
src/main.ts
66
src/main.ts
|
@ -1,14 +1,24 @@
|
||||||
import { setFailed, setOutput } from '@actions/core';
|
import {
|
||||||
import { getOctokit } from '@actions/github';
|
paths,
|
||||||
import { GitHubReleaser, release, upload } from './github';
|
parseConfig,
|
||||||
import { isTag, parseConfig, paths, unmatchedPatterns, uploadUrl } from './util';
|
isTag,
|
||||||
|
unmatchedPatterns,
|
||||||
|
uploadUrl,
|
||||||
|
} from "./util";
|
||||||
|
import { release, upload, GitHubReleaser } from "./github";
|
||||||
|
import { getOctokit } from "@actions/github";
|
||||||
|
import { setFailed, setOutput } from "@actions/core";
|
||||||
|
|
||||||
import { env } from 'process';
|
import { env } from "process";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
try {
|
try {
|
||||||
const config = parseConfig(env);
|
const config = parseConfig(env);
|
||||||
if (!config.input_tag_name && !isTag(config.github_ref) && !config.input_draft) {
|
if (
|
||||||
|
!config.input_tag_name &&
|
||||||
|
!isTag(config.github_ref) &&
|
||||||
|
!config.input_draft
|
||||||
|
) {
|
||||||
throw new Error(`⚠️ GitHub Releases requires a tag`);
|
throw new Error(`⚠️ GitHub Releases requires a tag`);
|
||||||
}
|
}
|
||||||
if (config.input_files) {
|
if (config.input_files) {
|
||||||
|
@ -34,7 +44,9 @@ async function run() {
|
||||||
//new oktokit(
|
//new oktokit(
|
||||||
throttle: {
|
throttle: {
|
||||||
onRateLimit: (retryAfter, options) => {
|
onRateLimit: (retryAfter, options) => {
|
||||||
console.warn(`Request quota exhausted for request ${options.method} ${options.url}`);
|
console.warn(
|
||||||
|
`Request quota exhausted for request ${options.method} ${options.url}`,
|
||||||
|
);
|
||||||
if (options.request.retryCount === 0) {
|
if (options.request.retryCount === 0) {
|
||||||
// only retries once
|
// only retries once
|
||||||
console.log(`Retrying after ${retryAfter} seconds!`);
|
console.log(`Retrying after ${retryAfter} seconds!`);
|
||||||
|
@ -43,7 +55,9 @@ async function run() {
|
||||||
},
|
},
|
||||||
onAbuseLimit: (retryAfter, options) => {
|
onAbuseLimit: (retryAfter, options) => {
|
||||||
// does not retry, only logs a warning
|
// does not retry, only logs a warning
|
||||||
console.warn(`Abuse detected for request ${options.method} ${options.url}`);
|
console.warn(
|
||||||
|
`Abuse detected for request ${options.method} ${options.url}`,
|
||||||
|
);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
@ -53,38 +67,44 @@ async function run() {
|
||||||
const files = paths(config.input_files);
|
const files = paths(config.input_files);
|
||||||
if (files.length == 0) {
|
if (files.length == 0) {
|
||||||
if (config.input_fail_on_unmatched_files) {
|
if (config.input_fail_on_unmatched_files) {
|
||||||
throw new Error(`⚠️ ${config.input_files} does not include a valid file.`);
|
throw new Error(
|
||||||
|
`⚠️ ${config.input_files} does not include a valid file.`,
|
||||||
|
);
|
||||||
} else {
|
} else {
|
||||||
console.warn(`🤔 ${config.input_files} does not include a valid file.`);
|
console.warn(
|
||||||
|
`🤔 ${config.input_files} does not include a valid file.`,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
const currentAssets = rel.assets;
|
const currentAssets = rel.assets;
|
||||||
|
|
||||||
const uploadFile = async (path) => {
|
const uploadFile = async (path) => {
|
||||||
const json = await upload(config, gh, uploadUrl(rel.upload_url), path, currentAssets);
|
const json = await upload(
|
||||||
if (json) {
|
config,
|
||||||
|
gh,
|
||||||
|
uploadUrl(rel.upload_url),
|
||||||
|
path,
|
||||||
|
currentAssets,
|
||||||
|
);
|
||||||
delete json.uploader;
|
delete json.uploader;
|
||||||
}
|
|
||||||
return json;
|
return json;
|
||||||
};
|
};
|
||||||
|
|
||||||
let results: (any | null)[];
|
let assets;
|
||||||
if (!config.input_preserve_order) {
|
if (!config.input_preserve_order) {
|
||||||
results = await Promise.all(files.map(uploadFile));
|
assets = await Promise.all(files.map(uploadFile));
|
||||||
} else {
|
} else {
|
||||||
results = [];
|
assets = [];
|
||||||
for (const path of files) {
|
for (const path of files) {
|
||||||
results.push(await uploadFile(path));
|
assets.push(await uploadFile(path));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
setOutput("assets", assets);
|
||||||
const assets = results.filter(Boolean);
|
|
||||||
setOutput('assets', assets);
|
|
||||||
}
|
}
|
||||||
console.log(`🎉 Release ready at ${rel.html_url}`);
|
console.log(`🎉 Release ready at ${rel.html_url}`);
|
||||||
setOutput('url', rel.html_url);
|
setOutput("url", rel.html_url);
|
||||||
setOutput('id', rel.id.toString());
|
setOutput("id", rel.id.toString());
|
||||||
setOutput('upload_url', rel.upload_url);
|
setOutput("upload_url", rel.upload_url);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
setFailed(error.message);
|
setFailed(error.message);
|
||||||
}
|
}
|
||||||
|
|
63
src/util.ts
63
src/util.ts
|
@ -1,5 +1,5 @@
|
||||||
import * as glob from 'glob';
|
import * as glob from "glob";
|
||||||
import { statSync, readFileSync } from 'fs';
|
import { statSync, readFileSync } from "fs";
|
||||||
|
|
||||||
export interface Config {
|
export interface Config {
|
||||||
github_token: string;
|
github_token: string;
|
||||||
|
@ -12,7 +12,6 @@ export interface Config {
|
||||||
input_body?: string;
|
input_body?: string;
|
||||||
input_body_path?: string;
|
input_body_path?: string;
|
||||||
input_files?: string[];
|
input_files?: string[];
|
||||||
input_overwrite_files?: boolean;
|
|
||||||
input_draft?: boolean;
|
input_draft?: boolean;
|
||||||
input_preserve_order?: boolean;
|
input_preserve_order?: boolean;
|
||||||
input_prerelease?: boolean;
|
input_prerelease?: boolean;
|
||||||
|
@ -21,11 +20,11 @@ export interface Config {
|
||||||
input_discussion_category_name?: string;
|
input_discussion_category_name?: string;
|
||||||
input_generate_release_notes?: boolean;
|
input_generate_release_notes?: boolean;
|
||||||
input_append_body?: boolean;
|
input_append_body?: boolean;
|
||||||
input_make_latest: 'true' | 'false' | 'legacy' | undefined;
|
input_make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const uploadUrl = (url: string): string => {
|
export const uploadUrl = (url: string): string => {
|
||||||
const templateMarkerPos = url.indexOf('{');
|
const templateMarkerPos = url.indexOf("{");
|
||||||
if (templateMarkerPos > -1) {
|
if (templateMarkerPos > -1) {
|
||||||
return url.substring(0, templateMarkerPos);
|
return url.substring(0, templateMarkerPos);
|
||||||
}
|
}
|
||||||
|
@ -34,7 +33,8 @@ export const uploadUrl = (url: string): string => {
|
||||||
|
|
||||||
export const releaseBody = (config: Config): string | undefined => {
|
export const releaseBody = (config: Config): string | undefined => {
|
||||||
return (
|
return (
|
||||||
(config.input_body_path && readFileSync(config.input_body_path).toString('utf8')) ||
|
(config.input_body_path &&
|
||||||
|
readFileSync(config.input_body_path).toString("utf8")) ||
|
||||||
config.input_body
|
config.input_body
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
@ -45,7 +45,7 @@ export const parseInputFiles = (files: string): string[] => {
|
||||||
return files.split(/\r?\n/).reduce<string[]>(
|
return files.split(/\r?\n/).reduce<string[]>(
|
||||||
(acc, line) =>
|
(acc, line) =>
|
||||||
acc
|
acc
|
||||||
.concat(line.split(','))
|
.concat(line.split(","))
|
||||||
.filter((pat) => pat)
|
.filter((pat) => pat)
|
||||||
.map((pat) => pat.trim()),
|
.map((pat) => pat.trim()),
|
||||||
[],
|
[],
|
||||||
|
@ -54,31 +54,35 @@ export const parseInputFiles = (files: string): string[] => {
|
||||||
|
|
||||||
export const parseConfig = (env: Env): Config => {
|
export const parseConfig = (env: Env): Config => {
|
||||||
return {
|
return {
|
||||||
github_token: env.GITHUB_TOKEN || env.INPUT_TOKEN || '',
|
github_token: env.GITHUB_TOKEN || env.INPUT_TOKEN || "",
|
||||||
github_ref: env.GITHUB_REF || '',
|
github_ref: env.GITHUB_REF || "",
|
||||||
github_repository: env.INPUT_REPOSITORY || env.GITHUB_REPOSITORY || '',
|
github_repository: env.INPUT_REPOSITORY || env.GITHUB_REPOSITORY || "",
|
||||||
input_name: env.INPUT_NAME,
|
input_name: env.INPUT_NAME,
|
||||||
input_tag_name: env.INPUT_TAG_NAME?.trim(),
|
input_tag_name: env.INPUT_TAG_NAME?.trim(),
|
||||||
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: parseInputFiles(env.INPUT_FILES || ''),
|
input_files: parseInputFiles(env.INPUT_FILES || ""),
|
||||||
input_overwrite_files: env.INPUT_OVERWRITE_FILES
|
input_draft: env.INPUT_DRAFT ? env.INPUT_DRAFT === "true" : undefined,
|
||||||
? env.INPUT_OVERWRITE_FILES == 'true'
|
input_preserve_order: env.INPUT_PRESERVE_ORDER
|
||||||
|
? env.INPUT_PRESERVE_ORDER == "true"
|
||||||
: undefined,
|
: undefined,
|
||||||
input_draft: env.INPUT_DRAFT ? env.INPUT_DRAFT === 'true' : undefined,
|
input_prerelease: env.INPUT_PRERELEASE
|
||||||
input_preserve_order: env.INPUT_PRESERVE_ORDER ? env.INPUT_PRESERVE_ORDER == 'true' : undefined,
|
? env.INPUT_PRERELEASE == "true"
|
||||||
input_prerelease: env.INPUT_PRERELEASE ? env.INPUT_PRERELEASE == 'true' : undefined,
|
: undefined,
|
||||||
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 || undefined,
|
input_target_commitish: env.INPUT_TARGET_COMMITISH || undefined,
|
||||||
input_discussion_category_name: env.INPUT_DISCUSSION_CATEGORY_NAME || undefined,
|
input_discussion_category_name:
|
||||||
input_generate_release_notes: env.INPUT_GENERATE_RELEASE_NOTES == 'true',
|
env.INPUT_DISCUSSION_CATEGORY_NAME || undefined,
|
||||||
input_append_body: env.INPUT_APPEND_BODY == 'true',
|
input_generate_release_notes: env.INPUT_GENERATE_RELEASE_NOTES == "true",
|
||||||
|
input_append_body: env.INPUT_APPEND_BODY == "true",
|
||||||
input_make_latest: parseMakeLatest(env.INPUT_MAKE_LATEST),
|
input_make_latest: parseMakeLatest(env.INPUT_MAKE_LATEST),
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
const parseMakeLatest = (value: string | undefined): 'true' | 'false' | 'legacy' | undefined => {
|
const parseMakeLatest = (
|
||||||
if (value === 'true' || value === 'false' || value === 'legacy') {
|
value: string | undefined,
|
||||||
|
): "true" | "false" | "legacy" | undefined => {
|
||||||
|
if (value === "true" || value === "false" || value === "legacy") {
|
||||||
return value;
|
return value;
|
||||||
}
|
}
|
||||||
return undefined;
|
return undefined;
|
||||||
|
@ -86,22 +90,29 @@ const parseMakeLatest = (value: string | undefined): 'true' | 'false' | 'legacy'
|
||||||
|
|
||||||
export const paths = (patterns: string[]): string[] => {
|
export const paths = (patterns: string[]): string[] => {
|
||||||
return patterns.reduce((acc: string[], pattern: string): string[] => {
|
return patterns.reduce((acc: string[], pattern: string): string[] => {
|
||||||
return acc.concat(glob.sync(pattern).filter((path) => statSync(path).isFile()));
|
return acc.concat(
|
||||||
|
glob
|
||||||
|
.sync(pattern)
|
||||||
|
.filter((path) => statSync(path).isFile())
|
||||||
|
.map((path) => path.replace(/\\/g, "/")),
|
||||||
|
);
|
||||||
}, []);
|
}, []);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const unmatchedPatterns = (patterns: string[]): string[] => {
|
export const unmatchedPatterns = (patterns: string[]): string[] => {
|
||||||
return patterns.reduce((acc: string[], pattern: string): string[] => {
|
return patterns.reduce((acc: string[], pattern: string): string[] => {
|
||||||
return acc.concat(
|
return acc.concat(
|
||||||
glob.sync(pattern).filter((path) => statSync(path).isFile()).length == 0 ? [pattern] : [],
|
glob.sync(pattern).filter((path) => statSync(path).isFile()).length == 0
|
||||||
|
? [pattern]
|
||||||
|
: [],
|
||||||
);
|
);
|
||||||
}, []);
|
}, []);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const isTag = (ref: string): boolean => {
|
export const isTag = (ref: string): boolean => {
|
||||||
return ref.startsWith('refs/tags/');
|
return ref.startsWith("refs/tags/");
|
||||||
};
|
};
|
||||||
|
|
||||||
export const alignAssetName = (assetName: string): string => {
|
export const alignAssetName = (assetName: string): string => {
|
||||||
return assetName.replace(/ /g, '.');
|
return assetName.replace(/ /g, ".");
|
||||||
};
|
};
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue