Compare commits
95 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
36833a1c71 | ||
|
8bb7207875 | ||
|
93bb5ff43e | ||
|
581b12c87f | ||
|
b540ad2354 | ||
|
ac224e9440 | ||
|
ab50eebb64 | ||
|
670eb2f21a | ||
|
4b4d743a9b | ||
|
daffc988f2 | ||
|
ffb524fa90 | ||
|
a921960380 | ||
|
51cfd90a6d | ||
|
431939b21f | ||
|
3792cde6c4 | ||
|
1fd6f3f2b1 | ||
|
7e44a1f6a7 | ||
|
67b6c38432 | ||
|
c43d7637b9 | ||
|
c95fe14893 | ||
|
deddb09c64 | ||
|
33fcd69d45 | ||
|
01050bd877 | ||
|
92dffe6c28 | ||
|
7b4da11513 | ||
|
64f1fa19ef | ||
|
9e35a64dfd | ||
|
92bc83c421 | ||
|
09f0e37203 | ||
|
f138a07409 | ||
|
39a5683760 | ||
|
62368ac126 | ||
|
181b5bc7bb | ||
|
3284404123 | ||
|
01570a1f39 | ||
|
d5f028c822 | ||
|
98daca21d1 | ||
|
b019a5bbb6 | ||
|
73e673b2de | ||
|
e7a8f85e1c | ||
|
04afa1392e | ||
|
894468a03c | ||
|
3bd23aa9ec | ||
|
21eb2f9554 | ||
|
cd8b57e572 | ||
|
820a5adc43 | ||
|
9d04f90cd8 | ||
|
aaf1d5f6d5 | ||
|
7d33a7ecc3 | ||
|
4ab8bf77de | ||
|
0a7d9cdbe4 | ||
|
aec195fdab | ||
|
b2cf127d24 | ||
|
285c2f0c13 | ||
|
c7857c88c0 | ||
|
42b6106688 | ||
|
79721680df | ||
|
33892d43f0 | ||
|
3362207ba1 | ||
|
24a040e564 | ||
|
9a28f2423f | ||
|
e5aff6f50f | ||
|
69d83aede9 | ||
|
0ab9029cac | ||
|
d1798aa3dc | ||
|
c062e08bd5 | ||
|
380635c4ad | ||
|
20adb4259c | ||
|
f808f15ba8 | ||
|
6145241049 | ||
|
4ac522d0bd | ||
|
25849b1326 | ||
|
62060560e3 | ||
|
39aadf190d | ||
|
6f3ab65323 | ||
|
cdef11965e | ||
|
48b853e7ea | ||
|
82b4a28696 | ||
|
fb2d03176f | ||
|
08d85b1534 | ||
|
a636f98a4d | ||
|
288696be39 | ||
|
6de5d7916c | ||
|
a485adba73 | ||
|
26f874e54a | ||
|
810bfa2cd5 | ||
|
019fc2114d | ||
|
a74c6b72af | ||
|
b909f761f0 | ||
|
e49d08fa32 | ||
|
f12ad255e1 | ||
|
7039a825a7 | ||
|
f9c2b6ca37 | ||
|
73738a6293 | ||
|
a500a35279 |
23
.github/dependabot.yml
vendored
23
.github/dependabot.yml
vendored
@ -1,14 +1,33 @@
|
|||||||
version: 2
|
version: 2
|
||||||
updates:
|
updates:
|
||||||
- package-ecosystem: npm
|
- package-ecosystem: npm
|
||||||
directory: "/"
|
directory: "/"
|
||||||
schedule:
|
schedule:
|
||||||
interval: weekly
|
interval: weekly
|
||||||
|
groups:
|
||||||
|
npm:
|
||||||
|
patterns:
|
||||||
|
- "*"
|
||||||
ignore:
|
ignore:
|
||||||
- dependency-name: node-fetch
|
- dependency-name: node-fetch
|
||||||
versions:
|
versions:
|
||||||
- ">=3.0.0"
|
- ">=3.0.0"
|
||||||
- package-ecosystem: github-actions
|
# ignore mime and @types/mime per https://github.com/softprops/action-gh-release/pull/475
|
||||||
|
- dependency-name: mime
|
||||||
|
versions:
|
||||||
|
- ">=4.0.0"
|
||||||
|
- dependency-name: "@types/mime"
|
||||||
|
versions:
|
||||||
|
- ">=4.0.0"
|
||||||
|
commit-message:
|
||||||
|
prefix: "chore(deps)"
|
||||||
|
- package-ecosystem: github-actions
|
||||||
directory: "/"
|
directory: "/"
|
||||||
schedule:
|
schedule:
|
||||||
interval: weekly
|
interval: weekly
|
||||||
|
groups:
|
||||||
|
github-actions:
|
||||||
|
patterns:
|
||||||
|
- "*"
|
||||||
|
commit-message:
|
||||||
|
prefix: "chore(deps)"
|
||||||
|
22
.github/release.yml
vendored
Normal file
22
.github/release.yml
vendored
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
changelog:
|
||||||
|
exclude:
|
||||||
|
labels:
|
||||||
|
- ignore-for-release
|
||||||
|
- github-actions
|
||||||
|
authors:
|
||||||
|
- octocat
|
||||||
|
- renovate[bot]
|
||||||
|
categories:
|
||||||
|
- title: Breaking Changes 🛠
|
||||||
|
labels:
|
||||||
|
- breaking-change
|
||||||
|
- title: Exciting New Features 🎉
|
||||||
|
labels:
|
||||||
|
- enhancement
|
||||||
|
- feature
|
||||||
|
- title: Bug fixes 🐛
|
||||||
|
labels:
|
||||||
|
- bug
|
||||||
|
- title: Other Changes 🔄
|
||||||
|
labels:
|
||||||
|
- "*"
|
18
.github/workflows/main.yml
vendored
18
.github/workflows/main.yml
vendored
@ -1,14 +1,20 @@
|
|||||||
name: Main
|
name: main
|
||||||
|
|
||||||
on: [pull_request, push]
|
on:
|
||||||
|
push:
|
||||||
|
pull_request:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-24.04
|
||||||
steps:
|
steps:
|
||||||
# https://github.com/actions/checkout
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
- uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
|
||||||
|
with:
|
||||||
|
node-version-file: ".tool-versions"
|
||||||
|
cache: "npm"
|
||||||
|
|
||||||
- name: Install
|
- name: Install
|
||||||
run: npm ci
|
run: npm ci
|
||||||
- name: Build
|
- name: Build
|
||||||
|
1
.tool-versions
Normal file
1
.tool-versions
Normal file
@ -0,0 +1 @@
|
|||||||
|
nodejs 20.15.1
|
80
CHANGELOG.md
80
CHANGELOG.md
@ -1,3 +1,83 @@
|
|||||||
|
## 2.2.1
|
||||||
|
|
||||||
|
## What's Changed
|
||||||
|
|
||||||
|
### Bug fixes 🐛
|
||||||
|
|
||||||
|
* fix: big file uploads by @xen0n in https://github.com/softprops/action-gh-release/pull/562
|
||||||
|
|
||||||
|
### Other Changes 🔄
|
||||||
|
* chore(deps): bump @types/node from 22.10.1 to 22.10.2 by @dependabot in https://github.com/softprops/action-gh-release/pull/559
|
||||||
|
* chore(deps): bump @types/node from 22.10.2 to 22.10.5 by @dependabot in https://github.com/softprops/action-gh-release/pull/569
|
||||||
|
* chore: update error and warning messages for not matching files in files field by @ytimocin in https://github.com/softprops/action-gh-release/pull/568
|
||||||
|
|
||||||
|
## 2.2.0
|
||||||
|
|
||||||
|
## What's Changed
|
||||||
|
|
||||||
|
### Exciting New Features 🎉
|
||||||
|
|
||||||
|
* feat: read the release assets asynchronously by @xen0n in https://github.com/softprops/action-gh-release/pull/552
|
||||||
|
|
||||||
|
### Bug fixes 🐛
|
||||||
|
|
||||||
|
* fix(docs): clarify the default for tag_name by @alexeagle in https://github.com/softprops/action-gh-release/pull/544
|
||||||
|
|
||||||
|
### Other Changes 🔄
|
||||||
|
|
||||||
|
* chore(deps): bump typescript from 5.6.3 to 5.7.2 by @dependabot in https://github.com/softprops/action-gh-release/pull/548
|
||||||
|
* chore(deps): bump @types/node from 22.9.0 to 22.9.4 by @dependabot in https://github.com/softprops/action-gh-release/pull/547
|
||||||
|
* chore(deps): bump cross-spawn from 7.0.3 to 7.0.6 by @dependabot in https://github.com/softprops/action-gh-release/pull/545
|
||||||
|
* chore(deps): bump @vercel/ncc from 0.38.2 to 0.38.3 by @dependabot in https://github.com/softprops/action-gh-release/pull/543
|
||||||
|
* chore(deps): bump prettier from 3.3.3 to 3.4.1 by @dependabot in https://github.com/softprops/action-gh-release/pull/550
|
||||||
|
* chore(deps): bump @types/node from 22.9.4 to 22.10.1 by @dependabot in https://github.com/softprops/action-gh-release/pull/551
|
||||||
|
* chore(deps): bump prettier from 3.4.1 to 3.4.2 by @dependabot in https://github.com/softprops/action-gh-release/pull/554
|
||||||
|
|
||||||
|
## 2.1.0
|
||||||
|
|
||||||
|
## What's Changed
|
||||||
|
|
||||||
|
### Exciting New Features 🎉
|
||||||
|
* feat: add support for release assets with multiple spaces within the name by @dukhine in https://github.com/softprops/action-gh-release/pull/518
|
||||||
|
* feat: preserve upload order by @richarddd in https://github.com/softprops/action-gh-release/pull/500
|
||||||
|
|
||||||
|
### Other Changes 🔄
|
||||||
|
* chore(deps): bump @types/node from 22.8.2 to 22.8.7 by @dependabot in https://github.com/softprops/action-gh-release/pull/539
|
||||||
|
|
||||||
|
## 2.0.9
|
||||||
|
|
||||||
|
- maintenance release with updated dependencies
|
||||||
|
|
||||||
|
## 2.0.8
|
||||||
|
|
||||||
|
### Other Changes 🔄
|
||||||
|
* chore(deps): bump prettier from 2.8.0 to 3.3.3 by @dependabot in https://github.com/softprops/action-gh-release/pull/480
|
||||||
|
* chore(deps): bump @types/node from 20.14.9 to 20.14.11 by @dependabot in https://github.com/softprops/action-gh-release/pull/483
|
||||||
|
* chore(deps): bump @octokit/plugin-throttling from 9.3.0 to 9.3.1 by @dependabot in https://github.com/softprops/action-gh-release/pull/484
|
||||||
|
* chore(deps): bump glob from 10.4.2 to 11.0.0 by @dependabot in https://github.com/softprops/action-gh-release/pull/477
|
||||||
|
* refactor: write jest config in ts by @chenrui333 in https://github.com/softprops/action-gh-release/pull/485
|
||||||
|
* chore(deps): bump @actions/github from 5.1.1 to 6.0.0 by @dependabot in https://github.com/softprops/action-gh-release/pull/470
|
||||||
|
|
||||||
|
## 2.0.7
|
||||||
|
|
||||||
|
### Bug fixes 🐛
|
||||||
|
|
||||||
|
* Fix missing update release body by @FirelightFlagboy in https://github.com/softprops/action-gh-release/pull/365
|
||||||
|
|
||||||
|
### Other Changes 🔄
|
||||||
|
|
||||||
|
* Bump @octokit/plugin-retry from 4.0.3 to 7.1.1 by @dependabot in https://github.com/softprops/action-gh-release/pull/443
|
||||||
|
* Bump typescript from 4.9.5 to 5.5.2 by @dependabot in https://github.com/softprops/action-gh-release/pull/467
|
||||||
|
* Bump @types/node from 20.14.6 to 20.14.8 by @dependabot in https://github.com/softprops/action-gh-release/pull/469
|
||||||
|
* Bump @types/node from 20.14.8 to 20.14.9 by @dependabot in https://github.com/softprops/action-gh-release/pull/473
|
||||||
|
* Bump typescript from 5.5.2 to 5.5.3 by @dependabot in https://github.com/softprops/action-gh-release/pull/472
|
||||||
|
* Bump ts-jest from 29.1.5 to 29.2.2 by @dependabot in https://github.com/softprops/action-gh-release/pull/479
|
||||||
|
* docs: document that existing releases are updated by @jvanbruegge in https://github.com/softprops/action-gh-release/pull/474
|
||||||
|
|
||||||
|
## 2.0.6
|
||||||
|
|
||||||
|
- maintenance release with updated dependencies
|
||||||
|
|
||||||
## 2.0.5
|
## 2.0.5
|
||||||
|
|
||||||
- Factor in file names with spaces when upserting files [#446](https://github.com/softprops/action-gh-release/pull/446) via [@MystiPanda](https://github.com/MystiPanda)
|
- Factor in file names with spaces when upserting files [#446](https://github.com/softprops/action-gh-release/pull/446) via [@MystiPanda](https://github.com/MystiPanda)
|
||||||
|
22
README.md
22
README.md
@ -21,6 +21,16 @@
|
|||||||
|
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
|
- [🤸 Usage](#-usage)
|
||||||
|
- [🚥 Limit releases to pushes to tags](#-limit-releases-to-pushes-to-tags)
|
||||||
|
- [⬆️ Uploading release assets](#️-uploading-release-assets)
|
||||||
|
- [📝 External release notes](#-external-release-notes)
|
||||||
|
- [💅 Customizing](#-customizing)
|
||||||
|
- [inputs](#inputs)
|
||||||
|
- [outputs](#outputs)
|
||||||
|
- [environment variables](#environment-variables)
|
||||||
|
- [Permissions](#permissions)
|
||||||
|
|
||||||
## 🤸 Usage
|
## 🤸 Usage
|
||||||
|
|
||||||
### 🚥 Limit releases to pushes to tags
|
### 🚥 Limit releases to pushes to tags
|
||||||
@ -44,7 +54,7 @@ jobs:
|
|||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
- name: Release
|
- name: Release
|
||||||
uses: softprops/action-gh-release@v2
|
uses: softprops/action-gh-release@v2
|
||||||
if: startsWith(github.ref, 'refs/tags/')
|
if: github.ref_type == 'tag'
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also use push config tag filter
|
You can also use push config tag filter
|
||||||
@ -75,6 +85,7 @@ 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 newline-delimited 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.
|
||||||
|
If a tag already has a GitHub release, the existing release will be updated with the release assets.
|
||||||
|
|
||||||
Below is an example of uploading a single asset named `Release.txt`
|
Below is an example of uploading a single asset named `Release.txt`
|
||||||
|
|
||||||
@ -95,7 +106,7 @@ jobs:
|
|||||||
run: cat Release.txt
|
run: cat Release.txt
|
||||||
- name: Release
|
- name: Release
|
||||||
uses: softprops/action-gh-release@v2
|
uses: softprops/action-gh-release@v2
|
||||||
if: startsWith(github.ref, 'refs/tags/')
|
if: github.ref_type == 'tag'
|
||||||
with:
|
with:
|
||||||
files: Release.txt
|
files: Release.txt
|
||||||
```
|
```
|
||||||
@ -119,7 +130,7 @@ jobs:
|
|||||||
run: cat Release.txt
|
run: cat Release.txt
|
||||||
- name: Release
|
- name: Release
|
||||||
uses: softprops/action-gh-release@v2
|
uses: softprops/action-gh-release@v2
|
||||||
if: startsWith(github.ref, 'refs/tags/')
|
if: github.ref_type == 'tag'
|
||||||
with:
|
with:
|
||||||
files: |
|
files: |
|
||||||
Release.txt
|
Release.txt
|
||||||
@ -151,7 +162,7 @@ jobs:
|
|||||||
run: echo "# Good things have arrived" > ${{ github.workspace }}-CHANGELOG.txt
|
run: echo "# Good things have arrived" > ${{ github.workspace }}-CHANGELOG.txt
|
||||||
- name: Release
|
- name: Release
|
||||||
uses: softprops/action-gh-release@v2
|
uses: softprops/action-gh-release@v2
|
||||||
if: startsWith(github.ref, 'refs/tags/')
|
if: github.ref_type == 'tag'
|
||||||
with:
|
with:
|
||||||
body_path: ${{ github.workspace }}-CHANGELOG.txt
|
body_path: ${{ github.workspace }}-CHANGELOG.txt
|
||||||
repository: my_gh_org/my_gh_repo
|
repository: my_gh_org/my_gh_repo
|
||||||
@ -172,9 +183,10 @@ The following are optional as `step.with` keys
|
|||||||
| `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 |
|
||||||
| `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 |
|
||||||
| `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 |
|
||||||
| `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` |
|
| `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 |
|
||||||
| `repository` | String | Name of a target repository in `<owner>/<repo>` format. Defaults to GITHUB_REPOSITORY env variable |
|
| `repository` | String | Name of a target repository in `<owner>/<repo>` format. Defaults to GITHUB_REPOSITORY env variable |
|
||||||
| `target_commitish` | String | Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Defaults to repository default branch. |
|
| `target_commitish` | String | Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Defaults to repository default branch. |
|
||||||
|
@ -1,6 +1,5 @@
|
|||||||
//import * as assert from "assert";
|
|
||||||
//const assert = require('assert');
|
|
||||||
import * as assert from "assert";
|
import * as assert from "assert";
|
||||||
|
import { text } from "stream/consumers";
|
||||||
import { mimeOrDefault, asset } from "../src/github";
|
import { mimeOrDefault, asset } from "../src/github";
|
||||||
|
|
||||||
describe("github", () => {
|
describe("github", () => {
|
||||||
@ -15,11 +14,10 @@ describe("github", () => {
|
|||||||
|
|
||||||
describe("asset", () => {
|
describe("asset", () => {
|
||||||
it("derives asset info from a path", async () => {
|
it("derives asset info from a path", async () => {
|
||||||
const { name, mime, size, data } = 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);
|
||||||
assert.equal(data.toString(), "release me");
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
@ -6,6 +6,7 @@ import {
|
|||||||
parseInputFiles,
|
parseInputFiles,
|
||||||
unmatchedPatterns,
|
unmatchedPatterns,
|
||||||
uploadUrl,
|
uploadUrl,
|
||||||
|
alignAssetName,
|
||||||
} from "../src/util";
|
} from "../src/util";
|
||||||
import * as assert from "assert";
|
import * as assert from "assert";
|
||||||
|
|
||||||
@ -14,9 +15,9 @@ describe("util", () => {
|
|||||||
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",
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@ -30,7 +31,7 @@ describe("util", () => {
|
|||||||
it("parses newline and comma-delimited (and then some)", () => {
|
it("parses newline and comma-delimited (and then some)", () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
parseInputFiles("foo,bar\nbaz,boom,\n\ndoom,loom "),
|
parseInputFiles("foo,bar\nbaz,boom,\n\ndoom,loom "),
|
||||||
["foo", "bar", "baz", "boom", "doom", "loom"]
|
["foo", "bar", "baz", "boom", "doom", "loom"],
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@ -46,6 +47,7 @@ describe("util", () => {
|
|||||||
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_files: [],
|
input_files: [],
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
@ -53,7 +55,7 @@ describe("util", () => {
|
|||||||
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("uses input body path", () => {
|
it("uses input body path", () => {
|
||||||
@ -67,6 +69,7 @@ describe("util", () => {
|
|||||||
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_files: [],
|
input_files: [],
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
@ -74,7 +77,7 @@ describe("util", () => {
|
|||||||
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("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", () => {
|
||||||
@ -88,6 +91,7 @@ describe("util", () => {
|
|||||||
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_files: [],
|
input_files: [],
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
@ -95,7 +99,7 @@ describe("util", () => {
|
|||||||
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,
|
||||||
})
|
}),
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@ -121,6 +125,7 @@ describe("util", () => {
|
|||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
input_draft: undefined,
|
input_draft: undefined,
|
||||||
input_prerelease: undefined,
|
input_prerelease: undefined,
|
||||||
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
@ -129,7 +134,7 @@ describe("util", () => {
|
|||||||
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,
|
||||||
}
|
},
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -148,6 +153,7 @@ describe("util", () => {
|
|||||||
input_draft: undefined,
|
input_draft: undefined,
|
||||||
input_prerelease: undefined,
|
input_prerelease: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
|
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,
|
||||||
@ -155,7 +161,7 @@ describe("util", () => {
|
|||||||
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", () => {
|
||||||
@ -173,6 +179,7 @@ describe("util", () => {
|
|||||||
input_draft: undefined,
|
input_draft: undefined,
|
||||||
input_prerelease: undefined,
|
input_prerelease: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
|
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,
|
||||||
@ -180,7 +187,7 @@ describe("util", () => {
|
|||||||
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,
|
||||||
}
|
},
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -198,6 +205,7 @@ describe("util", () => {
|
|||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
input_draft: undefined,
|
input_draft: undefined,
|
||||||
input_prerelease: undefined,
|
input_prerelease: undefined,
|
||||||
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
@ -206,7 +214,7 @@ describe("util", () => {
|
|||||||
input_discussion_category_name: undefined,
|
input_discussion_category_name: undefined,
|
||||||
input_generate_release_notes: true,
|
input_generate_release_notes: true,
|
||||||
input_make_latest: undefined,
|
input_make_latest: undefined,
|
||||||
}
|
},
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -215,6 +223,7 @@ describe("util", () => {
|
|||||||
parseConfig({
|
parseConfig({
|
||||||
INPUT_DRAFT: "false",
|
INPUT_DRAFT: "false",
|
||||||
INPUT_PRERELEASE: "true",
|
INPUT_PRERELEASE: "true",
|
||||||
|
INPUT_PRESERVE_ORDER: "true",
|
||||||
GITHUB_TOKEN: "env-token",
|
GITHUB_TOKEN: "env-token",
|
||||||
INPUT_TOKEN: "input-token",
|
INPUT_TOKEN: "input-token",
|
||||||
}),
|
}),
|
||||||
@ -227,6 +236,7 @@ describe("util", () => {
|
|||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
input_draft: false,
|
input_draft: false,
|
||||||
input_prerelease: true,
|
input_prerelease: true,
|
||||||
|
input_preserve_order: true,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
@ -235,7 +245,7 @@ describe("util", () => {
|
|||||||
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("uses input token as the source of GITHUB_TOKEN by default", () => {
|
it("uses input token as the source of GITHUB_TOKEN by default", () => {
|
||||||
@ -254,6 +264,7 @@ describe("util", () => {
|
|||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
input_draft: false,
|
input_draft: false,
|
||||||
input_prerelease: true,
|
input_prerelease: true,
|
||||||
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
@ -262,7 +273,7 @@ describe("util", () => {
|
|||||||
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("parses basic config with draft and prerelease", () => {
|
it("parses basic config with draft and prerelease", () => {
|
||||||
@ -280,6 +291,7 @@ describe("util", () => {
|
|||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
input_draft: false,
|
input_draft: false,
|
||||||
input_prerelease: true,
|
input_prerelease: true,
|
||||||
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
@ -288,7 +300,7 @@ describe("util", () => {
|
|||||||
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("parses basic config where make_latest is passed", () => {
|
it("parses basic config where make_latest is passed", () => {
|
||||||
@ -305,6 +317,7 @@ describe("util", () => {
|
|||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
input_draft: undefined,
|
input_draft: undefined,
|
||||||
input_prerelease: undefined,
|
input_prerelease: undefined,
|
||||||
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
@ -313,7 +326,7 @@ describe("util", () => {
|
|||||||
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", () => {
|
||||||
@ -330,6 +343,7 @@ describe("util", () => {
|
|||||||
input_body_path: undefined,
|
input_body_path: undefined,
|
||||||
input_draft: undefined,
|
input_draft: undefined,
|
||||||
input_prerelease: undefined,
|
input_prerelease: undefined,
|
||||||
|
input_preserve_order: undefined,
|
||||||
input_files: [],
|
input_files: [],
|
||||||
input_name: undefined,
|
input_name: undefined,
|
||||||
input_tag_name: undefined,
|
input_tag_name: undefined,
|
||||||
@ -338,7 +352,7 @@ describe("util", () => {
|
|||||||
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,
|
||||||
}
|
},
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@ -355,7 +369,7 @@ describe("util", () => {
|
|||||||
it("resolves files given a set of paths", async () => {
|
it("resolves files given a set of paths", async () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
paths(["tests/data/**/*", "tests/data/does/not/exist/*"]),
|
paths(["tests/data/**/*", "tests/data/does/not/exist/*"]),
|
||||||
["tests/data/foo/bar.txt"]
|
["tests/data/foo/bar.txt"],
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@ -364,8 +378,24 @@ describe("util", () => {
|
|||||||
it("returns the patterns that don't match any files", async () => {
|
it("returns the patterns that don't match any files", async () => {
|
||||||
assert.deepStrictEqual(
|
assert.deepStrictEqual(
|
||||||
unmatchedPatterns(["tests/data/**/*", "tests/data/does/not/exist/*"]),
|
unmatchedPatterns(["tests/data/**/*", "tests/data/does/not/exist/*"]),
|
||||||
["tests/data/does/not/exist/*"]
|
["tests/data/does/not/exist/*"],
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("replaceSpacesWithDots", () => {
|
||||||
|
it("replaces all spaces with dots", () => {
|
||||||
|
expect(alignAssetName("John Doe.bla")).toBe("John.Doe.bla");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("handles names with multiple spaces", () => {
|
||||||
|
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");
|
||||||
|
});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
@ -13,7 +13,7 @@ inputs:
|
|||||||
description: "Gives the release a custom name. Defaults to tag name"
|
description: "Gives the release a custom name. Defaults to tag name"
|
||||||
required: false
|
required: false
|
||||||
tag_name:
|
tag_name:
|
||||||
description: "Gives a tag name. Defaults to github.GITHUB_REF"
|
description: "Gives a tag name. Defaults to github.ref_name"
|
||||||
required: false
|
required: false
|
||||||
draft:
|
draft:
|
||||||
description: "Creates a draft release. Defaults to false"
|
description: "Creates a draft release. Defaults to false"
|
||||||
@ -21,6 +21,9 @@ inputs:
|
|||||||
prerelease:
|
prerelease:
|
||||||
description: "Identify the release as a prerelease. Defaults to false"
|
description: "Identify the release as a prerelease. Defaults to false"
|
||||||
required: false
|
required: false
|
||||||
|
preserve_order:
|
||||||
|
description: "Preserver the order of the artifacts when uploading"
|
||||||
|
required: false
|
||||||
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
|
||||||
@ -50,7 +53,7 @@ inputs:
|
|||||||
description: "Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Can be `true`, `false`, or `legacy`. Uses GitHub api default if not provided"
|
description: "Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Can be `true`, `false`, or `legacy`. Uses GitHub api default if not provided"
|
||||||
required: false
|
required: false
|
||||||
env:
|
env:
|
||||||
"GITHUB_TOKEN": "As provided by Github Actions"
|
GITHUB_TOKEN: "As provided by Github Actions"
|
||||||
outputs:
|
outputs:
|
||||||
url:
|
url:
|
||||||
description: "URL to the Release HTML Page"
|
description: "URL to the Release HTML Page"
|
||||||
|
10
dist/index.js
vendored
10
dist/index.js
vendored
File diff suppressed because one or more lines are too long
@ -1,11 +0,0 @@
|
|||||||
module.exports = {
|
|
||||||
clearMocks: true,
|
|
||||||
moduleFileExtensions: ['js', 'ts'],
|
|
||||||
testEnvironment: 'node',
|
|
||||||
testMatch: ['**/*.test.ts'],
|
|
||||||
testRunner: 'jest-circus/runner',
|
|
||||||
transform: {
|
|
||||||
'^.+\\.ts$': 'ts-jest'
|
|
||||||
},
|
|
||||||
verbose: true
|
|
||||||
}
|
|
16
jest.config.ts
Normal file
16
jest.config.ts
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
import type { JestConfigWithTsJest } from 'ts-jest';
|
||||||
|
|
||||||
|
const config: JestConfigWithTsJest = {
|
||||||
|
preset: 'ts-jest/presets/default-esm',
|
||||||
|
clearMocks: true,
|
||||||
|
moduleFileExtensions: ['js', 'ts'],
|
||||||
|
testEnvironment: 'node',
|
||||||
|
testMatch: ['**/*.test.ts'],
|
||||||
|
testRunner: 'jest-circus/runner',
|
||||||
|
transform: {
|
||||||
|
'^.+\\.ts$': 'ts-jest',
|
||||||
|
},
|
||||||
|
verbose: true,
|
||||||
|
};
|
||||||
|
|
||||||
|
export default config;
|
6112
package-lock.json
generated
6112
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
28
package.json
28
package.json
@ -1,11 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "action-gh-release",
|
"name": "action-gh-release",
|
||||||
"version": "2.0.5",
|
"version": "2.2.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",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "ncc build src/main.ts --minify",
|
"build": "ncc build src/main.ts --minify",
|
||||||
|
"build-debug": "ncc build src/main.ts --v8-cache --source-map",
|
||||||
"test": "jest",
|
"test": "jest",
|
||||||
"fmt": "prettier --write \"src/**/*.ts\" \"__tests__/**/*.ts\"",
|
"fmt": "prettier --write \"src/**/*.ts\" \"__tests__/**/*.ts\"",
|
||||||
"fmtcheck": "prettier --check \"src/**/*.ts\" \"__tests__/**/*.ts\"",
|
"fmtcheck": "prettier --check \"src/**/*.ts\" \"__tests__/**/*.ts\"",
|
||||||
@ -20,24 +21,25 @@
|
|||||||
],
|
],
|
||||||
"author": "softprops",
|
"author": "softprops",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": "^1.10.0",
|
"@actions/core": "^1.11.1",
|
||||||
"@actions/github": "^5.1.1",
|
"@actions/github": "^6.0.0",
|
||||||
"@octokit/plugin-retry": "^4.0.3",
|
"@octokit/plugin-retry": "^7.2.0",
|
||||||
"@octokit/plugin-throttling": "^4.3.2",
|
"@octokit/plugin-throttling": "^9.6.1",
|
||||||
"glob": "^8.0.3",
|
"glob": "^11.0.1",
|
||||||
"mime": "^3.0.0"
|
"mime": "^3.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/glob": "^8.0.0",
|
"@types/glob": "^8.1.0",
|
||||||
"@types/jest": "^29.2.3",
|
"@types/jest": "^29.5.14",
|
||||||
"@types/mime": "^3.0.1",
|
"@types/mime": "^3.0.1",
|
||||||
"@types/node": "^18.11.9",
|
"@types/node": "^22.14.0",
|
||||||
"@vercel/ncc": "^0.34.0",
|
"@vercel/ncc": "^0.38.3",
|
||||||
"jest": "^29.3.1",
|
"jest": "^29.3.1",
|
||||||
"jest-circus": "^29.3.1",
|
"jest-circus": "^29.3.1",
|
||||||
"prettier": "2.8.0",
|
"prettier": "3.5.3",
|
||||||
"ts-jest": "^29.0.3",
|
"ts-jest": "^29.3.1",
|
||||||
"typescript": "^4.9.3",
|
"ts-node": "^10.9.2",
|
||||||
|
"typescript": "^5.8.3",
|
||||||
"typescript-formatter": "^7.2.2"
|
"typescript-formatter": "^7.2.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
126
src/github.ts
126
src/github.ts
@ -1,6 +1,7 @@
|
|||||||
import { GitHub } from "@actions/github/lib/utils";
|
import { GitHub } from "@actions/github/lib/utils";
|
||||||
import { Config, isTag, releaseBody } from "./util";
|
import { Config, isTag, releaseBody, alignAssetName } from "./util";
|
||||||
import { statSync, readFileSync } from "fs";
|
import { statSync } from "fs";
|
||||||
|
import { open } from "fs/promises";
|
||||||
import { getType } from "mime";
|
import { getType } from "mime";
|
||||||
import { basename } from "path";
|
import { basename } from "path";
|
||||||
|
|
||||||
@ -10,7 +11,6 @@ export interface ReleaseAsset {
|
|||||||
name: string;
|
name: string;
|
||||||
mime: string;
|
mime: string;
|
||||||
size: number;
|
size: number;
|
||||||
data: Buffer;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface Release {
|
export interface Release {
|
||||||
@ -44,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: string | undefined;
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
}): Promise<{ data: Release }>;
|
}): Promise<{ data: Release }>;
|
||||||
|
|
||||||
updateRelease(params: {
|
updateRelease(params: {
|
||||||
@ -59,7 +59,7 @@ 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: string | undefined;
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
}): Promise<{ data: Release }>;
|
}): Promise<{ data: Release }>;
|
||||||
|
|
||||||
allReleases(params: {
|
allReleases(params: {
|
||||||
@ -93,8 +93,15 @@ 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: string | undefined;
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
}): Promise<{ data: Release }> {
|
}): Promise<{ data: Release }> {
|
||||||
|
if (
|
||||||
|
typeof params.make_latest === "string" &&
|
||||||
|
!["true", "false", "legacy"].includes(params.make_latest)
|
||||||
|
) {
|
||||||
|
params.make_latest = undefined;
|
||||||
|
}
|
||||||
|
|
||||||
return this.github.rest.repos.createRelease(params);
|
return this.github.rest.repos.createRelease(params);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -110,8 +117,15 @@ 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: string | undefined;
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
}): Promise<{ data: Release }> {
|
}): Promise<{ data: Release }> {
|
||||||
|
if (
|
||||||
|
typeof params.make_latest === "string" &&
|
||||||
|
!["true", "false", "legacy"].includes(params.make_latest)
|
||||||
|
) {
|
||||||
|
params.make_latest = undefined;
|
||||||
|
}
|
||||||
|
|
||||||
return this.github.rest.repos.updateRelease(params);
|
return this.github.rest.repos.updateRelease(params);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -121,7 +135,7 @@ export class GitHubReleaser implements Releaser {
|
|||||||
}): AsyncIterableIterator<{ data: Release[] }> {
|
}): 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),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -131,7 +145,6 @@ export const asset = (path: string): ReleaseAsset => {
|
|||||||
name: basename(path),
|
name: basename(path),
|
||||||
mime: mimeOrDefault(path),
|
mime: mimeOrDefault(path),
|
||||||
size: statSync(path).size,
|
size: statSync(path).size,
|
||||||
data: readFileSync(path),
|
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -144,15 +157,15 @@ export const upload = async (
|
|||||||
github: GitHub,
|
github: GitHub,
|
||||||
url: string,
|
url: string,
|
||||||
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, size, mime, data: body } = 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.
|
||||||
// due to this renaming we need to be mindful when we compare the file name we're uploading with a name github may already have rewritten for logical comparison
|
// due to this renaming we need to be mindful when we compare the file name we're uploading with a name github may already have rewritten for logical comparison
|
||||||
// see https://docs.github.com/en/rest/releases/assets?apiVersion=2022-11-28#upload-a-release-asset
|
// see https://docs.github.com/en/rest/releases/assets?apiVersion=2022-11-28#upload-a-release-asset
|
||||||
({ name: currentName }) => currentName == name.replace(" ", ".")
|
({ name: currentName }) => currentName == alignAssetName(name),
|
||||||
);
|
);
|
||||||
if (currentAsset) {
|
if (currentAsset) {
|
||||||
console.log(`♻️ Deleting previously uploaded asset ${name}...`);
|
console.log(`♻️ Deleting previously uploaded asset ${name}...`);
|
||||||
@ -165,6 +178,8 @@ export const upload = async (
|
|||||||
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);
|
||||||
|
try {
|
||||||
const resp = await github.request({
|
const resp = await github.request({
|
||||||
method: "POST",
|
method: "POST",
|
||||||
url: endpoint.toString(),
|
url: endpoint.toString(),
|
||||||
@ -173,23 +188,27 @@ export const upload = async (
|
|||||||
"content-type": mime,
|
"content-type": mime,
|
||||||
authorization: `token ${config.github_token}`,
|
authorization: `token ${config.github_token}`,
|
||||||
},
|
},
|
||||||
data: body,
|
data: fh.readableWebStream({ type: "bytes" }),
|
||||||
});
|
});
|
||||||
const json = resp.data;
|
const json = resp.data;
|
||||||
if (resp.status !== 201) {
|
if (resp.status !== 201) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`Failed to upload release asset ${name}. received status code ${
|
`Failed to upload release asset ${name}. received status code ${
|
||||||
resp.status
|
resp.status
|
||||||
}\n${json.message}\n${JSON.stringify(json.errors)}`
|
}\n${json.message}\n${JSON.stringify(json.errors)}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
console.log(`✅ Uploaded ${name}`);
|
||||||
return json;
|
return json;
|
||||||
|
} finally {
|
||||||
|
await fh.close();
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
export const release = async (
|
export const release = async (
|
||||||
config: Config,
|
config: Config,
|
||||||
releaser: Releaser,
|
releaser: Releaser,
|
||||||
maxRetries: number = 3
|
maxRetries: number = 3,
|
||||||
): Promise<Release> => {
|
): Promise<Release> => {
|
||||||
if (maxRetries <= 0) {
|
if (maxRetries <= 0) {
|
||||||
console.log(`❌ Too many retries. Aborting...`);
|
console.log(`❌ Too many retries. Aborting...`);
|
||||||
@ -206,47 +225,58 @@ export const release = async (
|
|||||||
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 {
|
||||||
// you can't get a an existing draft by tag
|
// you can't get an existing draft by tag
|
||||||
// so we must find one in the list of all releases
|
// so we must find one in the list of all releases
|
||||||
if (config.input_draft) {
|
let _release: Release | undefined = undefined;
|
||||||
for await (const response of releaser.allReleases({
|
for await (const response of releaser.allReleases({
|
||||||
owner,
|
owner,
|
||||||
repo,
|
repo,
|
||||||
})) {
|
})) {
|
||||||
let release = response.data.find((release) => release.tag_name === tag);
|
_release = response.data.find((release) => release.tag_name === tag);
|
||||||
if (release) {
|
if (_release !== undefined) {
|
||||||
return release;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
if (_release === undefined) {
|
||||||
let existingRelease = await releaser.getReleaseByTag({
|
return await createRelease(
|
||||||
|
tag,
|
||||||
|
config,
|
||||||
|
releaser,
|
||||||
owner,
|
owner,
|
||||||
repo,
|
repo,
|
||||||
tag,
|
discussion_category_name,
|
||||||
});
|
generate_release_notes,
|
||||||
|
maxRetries,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
const release_id = existingRelease.data.id;
|
let existingRelease: Release = _release!;
|
||||||
|
console.log(
|
||||||
|
`Found release ${existingRelease.name} (with id=${existingRelease.id})`,
|
||||||
|
);
|
||||||
|
|
||||||
|
const release_id = existingRelease.id;
|
||||||
let target_commitish: string;
|
let target_commitish: string;
|
||||||
if (
|
if (
|
||||||
config.input_target_commitish &&
|
config.input_target_commitish &&
|
||||||
config.input_target_commitish !== existingRelease.data.target_commitish
|
config.input_target_commitish !== existingRelease.target_commitish
|
||||||
) {
|
) {
|
||||||
console.log(
|
console.log(
|
||||||
`Updating commit from "${existingRelease.data.target_commitish}" to "${config.input_target_commitish}"`
|
`Updating commit from "${existingRelease.target_commitish}" to "${config.input_target_commitish}"`,
|
||||||
);
|
);
|
||||||
target_commitish = config.input_target_commitish;
|
target_commitish = config.input_target_commitish;
|
||||||
} else {
|
} else {
|
||||||
target_commitish = existingRelease.data.target_commitish;
|
target_commitish = existingRelease.target_commitish;
|
||||||
}
|
}
|
||||||
|
|
||||||
const tag_name = tag;
|
const tag_name = tag;
|
||||||
const name = config.input_name || existingRelease.data.name || tag;
|
const name = config.input_name || existingRelease.name || tag;
|
||||||
// revisit: support a new body-concat-strategy input for accumulating
|
// revisit: support a new body-concat-strategy input for accumulating
|
||||||
// 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.data.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;
|
||||||
@ -257,11 +287,11 @@ export const release = async (
|
|||||||
const draft =
|
const draft =
|
||||||
config.input_draft !== undefined
|
config.input_draft !== undefined
|
||||||
? config.input_draft
|
? config.input_draft
|
||||||
: existingRelease.data.draft;
|
: existingRelease.draft;
|
||||||
const prerelease =
|
const prerelease =
|
||||||
config.input_prerelease !== undefined
|
config.input_prerelease !== undefined
|
||||||
? config.input_prerelease
|
? config.input_prerelease
|
||||||
: existingRelease.data.prerelease;
|
: existingRelease.prerelease;
|
||||||
|
|
||||||
const make_latest = config.input_make_latest;
|
const make_latest = config.input_make_latest;
|
||||||
|
|
||||||
@ -283,11 +313,34 @@ export const release = async (
|
|||||||
} catch (error) {
|
} catch (error) {
|
||||||
if (error.status !== 404) {
|
if (error.status !== 404) {
|
||||||
console.log(
|
console.log(
|
||||||
`⚠️ Unexpected error fetching GitHub release for tag ${config.github_ref}: ${error}`
|
`⚠️ Unexpected error fetching GitHub release for tag ${config.github_ref}: ${error}`,
|
||||||
);
|
);
|
||||||
throw error;
|
throw error;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return await createRelease(
|
||||||
|
tag,
|
||||||
|
config,
|
||||||
|
releaser,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
discussion_category_name,
|
||||||
|
generate_release_notes,
|
||||||
|
maxRetries,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
async function createRelease(
|
||||||
|
tag: string,
|
||||||
|
config: Config,
|
||||||
|
releaser: Releaser,
|
||||||
|
owner: string,
|
||||||
|
repo: string,
|
||||||
|
discussion_category_name: string | undefined,
|
||||||
|
generate_release_notes: boolean | undefined,
|
||||||
|
maxRetries: number,
|
||||||
|
) {
|
||||||
const tag_name = tag;
|
const tag_name = tag;
|
||||||
const name = config.input_name || tag;
|
const name = config.input_name || tag;
|
||||||
const body = releaseBody(config);
|
const body = releaseBody(config);
|
||||||
@ -300,7 +353,7 @@ export const release = async (
|
|||||||
commitMessage = ` using commit "${target_commitish}"`;
|
commitMessage = ` using commit "${target_commitish}"`;
|
||||||
}
|
}
|
||||||
console.log(
|
console.log(
|
||||||
`👩🏭 Creating new GitHub release for tag ${tag_name}${commitMessage}...`
|
`👩🏭 Creating new GitHub release for tag ${tag_name}${commitMessage}...`,
|
||||||
);
|
);
|
||||||
try {
|
try {
|
||||||
let release = await releaser.createRelease({
|
let release = await releaser.createRelease({
|
||||||
@ -325,7 +378,7 @@ export const release = async (
|
|||||||
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;
|
||||||
|
|
||||||
@ -341,5 +394,4 @@ export const release = async (
|
|||||||
console.log(`retrying... (${maxRetries - 1} retries remaining)`);
|
console.log(`retrying... (${maxRetries - 1} retries remaining)`);
|
||||||
return release(config, releaser, maxRetries - 1);
|
return release(config, releaser, maxRetries - 1);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
|
||||||
|
34
src/main.ts
34
src/main.ts
@ -8,7 +8,6 @@ import {
|
|||||||
import { release, upload, GitHubReleaser } from "./github";
|
import { release, upload, GitHubReleaser } from "./github";
|
||||||
import { getOctokit } from "@actions/github";
|
import { getOctokit } from "@actions/github";
|
||||||
import { setFailed, setOutput } from "@actions/core";
|
import { setFailed, setOutput } from "@actions/core";
|
||||||
import { GitHub, getOctokitOptions } from "@actions/github/lib/utils";
|
|
||||||
|
|
||||||
import { env } from "process";
|
import { env } from "process";
|
||||||
|
|
||||||
@ -46,7 +45,7 @@ async function run() {
|
|||||||
throttle: {
|
throttle: {
|
||||||
onRateLimit: (retryAfter, options) => {
|
onRateLimit: (retryAfter, options) => {
|
||||||
console.warn(
|
console.warn(
|
||||||
`Request quota exhausted for request ${options.method} ${options.url}`
|
`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
|
||||||
@ -57,7 +56,7 @@ 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(
|
console.warn(
|
||||||
`Abuse detected for request ${options.method} ${options.url}`
|
`Abuse detected for request ${options.method} ${options.url}`,
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -68,27 +67,38 @@ 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} not include valid file.`);
|
throw new Error(
|
||||||
|
`⚠️ ${config.input_files} does not include a valid file.`,
|
||||||
|
);
|
||||||
} else {
|
} else {
|
||||||
console.warn(`🤔 ${config.input_files} not include valid file.`);
|
console.warn(
|
||||||
|
`🤔 ${config.input_files} does not include a valid file.`,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
const currentAssets = rel.assets;
|
const currentAssets = rel.assets;
|
||||||
const assets = await Promise.all(
|
|
||||||
files.map(async (path) => {
|
const uploadFile = async (path) => {
|
||||||
const json = await upload(
|
const json = await upload(
|
||||||
config,
|
config,
|
||||||
gh,
|
gh,
|
||||||
uploadUrl(rel.upload_url),
|
uploadUrl(rel.upload_url),
|
||||||
path,
|
path,
|
||||||
currentAssets
|
currentAssets,
|
||||||
);
|
);
|
||||||
delete json.uploader;
|
delete json.uploader;
|
||||||
return json;
|
return json;
|
||||||
})
|
};
|
||||||
).catch((error) => {
|
|
||||||
throw error;
|
let assets;
|
||||||
});
|
if (!config.input_preserve_order) {
|
||||||
|
assets = await Promise.all(files.map(uploadFile));
|
||||||
|
} else {
|
||||||
|
assets = [];
|
||||||
|
for (const path of files) {
|
||||||
|
assets.push(await uploadFile(path));
|
||||||
|
}
|
||||||
|
}
|
||||||
setOutput("assets", assets);
|
setOutput("assets", assets);
|
||||||
}
|
}
|
||||||
console.log(`🎉 Release ready at ${rel.html_url}`);
|
console.log(`🎉 Release ready at ${rel.html_url}`);
|
||||||
|
29
src/util.ts
29
src/util.ts
@ -13,13 +13,14 @@ export interface Config {
|
|||||||
input_body_path?: string;
|
input_body_path?: string;
|
||||||
input_files?: string[];
|
input_files?: string[];
|
||||||
input_draft?: boolean;
|
input_draft?: boolean;
|
||||||
|
input_preserve_order?: boolean;
|
||||||
input_prerelease?: boolean;
|
input_prerelease?: boolean;
|
||||||
input_fail_on_unmatched_files?: boolean;
|
input_fail_on_unmatched_files?: boolean;
|
||||||
input_target_commitish?: string;
|
input_target_commitish?: string;
|
||||||
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: string | undefined;
|
input_make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const uploadUrl = (url: string): string => {
|
export const uploadUrl = (url: string): string => {
|
||||||
@ -47,7 +48,7 @@ export const parseInputFiles = (files: string): string[] => {
|
|||||||
.concat(line.split(","))
|
.concat(line.split(","))
|
||||||
.filter((pat) => pat)
|
.filter((pat) => pat)
|
||||||
.map((pat) => pat.trim()),
|
.map((pat) => pat.trim()),
|
||||||
[]
|
[],
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -62,6 +63,9 @@ export const parseConfig = (env: Env): Config => {
|
|||||||
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_draft: env.INPUT_DRAFT ? env.INPUT_DRAFT === "true" : undefined,
|
input_draft: env.INPUT_DRAFT ? env.INPUT_DRAFT === "true" : undefined,
|
||||||
|
input_preserve_order: env.INPUT_PRESERVE_ORDER
|
||||||
|
? env.INPUT_PRESERVE_ORDER == "true"
|
||||||
|
: undefined,
|
||||||
input_prerelease: env.INPUT_PRERELEASE
|
input_prerelease: env.INPUT_PRERELEASE
|
||||||
? env.INPUT_PRERELEASE == "true"
|
? env.INPUT_PRERELEASE == "true"
|
||||||
: undefined,
|
: undefined,
|
||||||
@ -71,16 +75,23 @@ export const parseConfig = (env: Env): Config => {
|
|||||||
env.INPUT_DISCUSSION_CATEGORY_NAME || undefined,
|
env.INPUT_DISCUSSION_CATEGORY_NAME || undefined,
|
||||||
input_generate_release_notes: env.INPUT_GENERATE_RELEASE_NOTES == "true",
|
input_generate_release_notes: env.INPUT_GENERATE_RELEASE_NOTES == "true",
|
||||||
input_append_body: env.INPUT_APPEND_BODY == "true",
|
input_append_body: env.INPUT_APPEND_BODY == "true",
|
||||||
input_make_latest: env.INPUT_MAKE_LATEST
|
input_make_latest: parseMakeLatest(env.INPUT_MAKE_LATEST),
|
||||||
? env.INPUT_MAKE_LATEST
|
|
||||||
: undefined,
|
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const parseMakeLatest = (
|
||||||
|
value: string | undefined,
|
||||||
|
): "true" | "false" | "legacy" | undefined => {
|
||||||
|
if (value === "true" || value === "false" || value === "legacy") {
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
return undefined;
|
||||||
|
};
|
||||||
|
|
||||||
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(
|
return acc.concat(
|
||||||
glob.sync(pattern).filter((path) => statSync(path).isFile())
|
glob.sync(pattern).filter((path) => statSync(path).isFile()),
|
||||||
);
|
);
|
||||||
}, []);
|
}, []);
|
||||||
};
|
};
|
||||||
@ -90,7 +101,7 @@ export const unmatchedPatterns = (patterns: string[]): string[] => {
|
|||||||
return acc.concat(
|
return acc.concat(
|
||||||
glob.sync(pattern).filter((path) => statSync(path).isFile()).length == 0
|
glob.sync(pattern).filter((path) => statSync(path).isFile()).length == 0
|
||||||
? [pattern]
|
? [pattern]
|
||||||
: []
|
: [],
|
||||||
);
|
);
|
||||||
}, []);
|
}, []);
|
||||||
};
|
};
|
||||||
@ -98,3 +109,7 @@ export const unmatchedPatterns = (patterns: string[]): string[] => {
|
|||||||
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 => {
|
||||||
|
return assetName.replace(/ /g, ".");
|
||||||
|
};
|
||||||
|
@ -60,5 +60,5 @@
|
|||||||
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
|
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
|
||||||
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
|
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
|
||||||
},
|
},
|
||||||
"exclude": ["node_modules", "**/*.test.ts"]
|
"exclude": ["node_modules", "**/*.test.ts", "jest.config.ts"]
|
||||||
}
|
}
|
Loading…
x
Reference in New Issue
Block a user