Compare commits
325 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 | ||
|
69320dbe05 | ||
|
9771ccf55f | ||
|
0a76e4214a | ||
|
3989e4b325 | ||
|
72e945e627 | ||
|
40bf9ec7aa | ||
|
998623f0c3 | ||
|
0979303f02 | ||
|
9b795e5782 | ||
|
9d7c94cfd0 | ||
|
6ffed59e55 | ||
|
1ce812a7bd | ||
|
3198ee18f8 | ||
|
7ee8e06381 | ||
|
d99959edae | ||
|
0e39c679e8 | ||
|
20e085ccc7 | ||
|
9f5c4d39bc | ||
|
0bea76b227 | ||
|
762fe13dfb | ||
|
c0f2569fb9 | ||
|
5743e06024 | ||
|
fe71fd3b91 | ||
|
9150ab13f3 | ||
|
74195ccd05 | ||
|
611b8bcc8e | ||
|
1468521d63 | ||
|
9e05c79559 | ||
|
e985949726 | ||
|
a6c7483a42 | ||
|
975c1b265e | ||
|
4634c16e79 | ||
|
c9b46fe7aa | ||
|
d4e8205d7e | ||
|
9114792eb2 | ||
|
b4025e2cdd | ||
|
970e29c7f0 | ||
|
de2c0eb89a | ||
|
c4dd3270ce | ||
|
0bd7e8b279 | ||
|
cd28b0f5ee | ||
|
faf0426de3 | ||
|
50195ba7f6 | ||
|
fe9a9bd329 | ||
|
8a65c81355 | ||
|
44946dc88f | ||
|
58fa4b7a88 | ||
|
b260a9f8a6 | ||
|
17cd0d34de | ||
|
15d2aaca23 | ||
|
0465cdad11 | ||
|
69a9b03fd9 | ||
|
a80139913a | ||
|
6034af24fb | ||
|
0b1e2e4582 | ||
|
a3f0173fb3 | ||
|
2d72d869af | ||
|
730b76a669 | ||
|
815e458579 | ||
|
6ecde844e8 | ||
|
487fcd9442 | ||
|
8b7a7c0162 | ||
|
6c87482fb9 | ||
|
2956b0de81 | ||
|
0aec73c6d6 | ||
|
ce95482067 | ||
|
2861dc8673 | ||
|
dd98a235fd | ||
|
4de103f838 | ||
|
003621c2ca | ||
|
59c3b48916 | ||
|
8779b820d9 | ||
|
d2a05f5e5a | ||
|
fb0163a75b | ||
|
07c2133a09 | ||
|
f5d13571ca | ||
|
5e6fc64554 | ||
|
fdb5f68261 | ||
|
2b68b29aae | ||
|
6aeb2b7009 | ||
|
b323b1872a | ||
|
7fd0762403 | ||
|
f6cd293a1e | ||
|
350afcd40d | ||
|
7cf90a9adf | ||
|
51ef4d3b15 | ||
|
2e6aa9a7f0 | ||
|
12960c68c9 | ||
|
e314c6fe22 | ||
|
3973e5f15a | ||
|
cb6e676133 | ||
|
defeeb7d92 | ||
|
9f3b580ccc | ||
|
59b9126341 | ||
|
04c14f526b | ||
|
2934fce629 | ||
|
674bcd2d67 | ||
|
6f63b4506e | ||
|
36fae76a5c | ||
|
5eea929306 | ||
|
12d1ded340 | ||
|
766a84c1cf | ||
|
3c49988886 | ||
|
4204c40f52 | ||
|
f1168d714c | ||
|
ccb8d16f08 | ||
|
75dbd0cd0e | ||
|
ec9df7c385 | ||
|
03c4bc34bd | ||
|
0a4afc0be2 | ||
|
0a19cfc696 | ||
|
b1829982df | ||
|
688f58f697 | ||
|
08e53e60c8 | ||
|
bb2c91bef9 | ||
|
e020468dd2 | ||
|
5e3f23f92c | ||
|
104b6490a7 | ||
|
a544ba8d92 | ||
|
9729932bfb | ||
|
cebd052c1e | ||
|
3b4957b6fd | ||
|
35d938cf01 | ||
|
e99df7cd80 | ||
|
05d11c9fe8 | ||
|
1f8f474abe | ||
|
94651eb27f | ||
|
dac15d39e4 | ||
|
7e3b173db6 | ||
|
d5e4f508ae | ||
|
affa18ef97 | ||
|
2cf5c66450 | ||
|
aabd85678e | ||
|
4fb86a77e0 | ||
|
9439581056 | ||
|
9a89d1e63f | ||
|
91409e712c | ||
|
b238fd05b1 | ||
|
a0dc82a74f | ||
|
924757492e | ||
|
9993ae8534 | ||
|
9f4852ebe6 | ||
|
b7e450da2a | ||
|
6195d81339 | ||
|
2803ccaf23 | ||
|
c66575c5e3 | ||
|
62eba970e0 | ||
|
7a7960d4c7 | ||
|
d651ef48cb | ||
|
37ae175992 | ||
|
d31b44251d | ||
|
0e414c630a | ||
|
9a2319ecaf | ||
|
7363c39621 | ||
|
742de9953a | ||
|
e234343e3e | ||
|
c99850e5d1 | ||
|
845942e04a | ||
|
1a522d88d8 | ||
|
56b4c8a8ef | ||
|
723bed634e | ||
|
2e7c800734 | ||
|
6247f9299a | ||
|
5d578441a6 | ||
|
42a316b84f | ||
|
6ecc92f5ad | ||
|
e7b71cc1a7 | ||
|
f26a08096a | ||
|
ba42ad9139 | ||
|
07c8c20669 | ||
|
00c56dd770 | ||
|
50c843ac1c | ||
|
ef036888ec | ||
|
2758344bdf | ||
|
18d8be76a0 | ||
|
2984051a42 | ||
|
a95bad53b2 | ||
|
bd839f3b8f | ||
|
e812c4aca6 | ||
|
615fb448a2 | ||
|
77f9a4f575 | ||
|
3af8783d41 | ||
|
a6281eb824 | ||
|
fbe4f1f3ad | ||
|
916d072e3d | ||
|
ca93e708e3 | ||
|
85bb079141 | ||
|
46f6b8d27b | ||
|
fcf37b79bd | ||
|
a31211f9ff | ||
|
f3c225f2b8 | ||
|
5f2e9fb50f | ||
|
9f9f2a3ed2 | ||
|
e2bd814f0a | ||
|
6bdc1677a5 | ||
|
2a55ae4b12 | ||
|
d2403f49f5 | ||
|
1b3edca894 | ||
|
23b784b656 | ||
|
29058f2f68 | ||
|
d2e9e54ff2 | ||
|
bb78d54396 | ||
|
ef96a2eb52 | ||
|
624fcca9a1 | ||
|
e5cba7ebb2 | ||
|
b95cbf8762 | ||
|
60358a145c | ||
|
c7638c8893 | ||
|
6fa875df0b | ||
|
e197e56931 | ||
|
cf2aed3a12 | ||
|
d644a384fb | ||
|
e48a25bf4e | ||
|
6ef3c4f0b3 | ||
|
67ba06729b | ||
|
722f21acbd | ||
|
7ab8811117 | ||
|
e60d11aee8 | ||
|
54832a3b39 | ||
|
4fe7e8efaa | ||
|
d30d20cc01 | ||
|
b70b9666e8 | ||
|
2940cbc2ff | ||
|
9e07fb233a | ||
|
212db5146b | ||
|
d27570c9ab | ||
|
cf0f3ebbb1 | ||
|
b241ff3653 | ||
|
18daf2c63f | ||
|
090932e783 |
@ -1,3 +0,0 @@
|
|||||||
.github
|
|
||||||
target/rls
|
|
||||||
tests
|
|
1
.github/FUNDING.yml
vendored
Normal file
1
.github/FUNDING.yml
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
ko_fi: softprops
|
33
.github/dependabot.yml
vendored
Normal file
33
.github/dependabot.yml
vendored
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: npm
|
||||||
|
directory: "/"
|
||||||
|
schedule:
|
||||||
|
interval: weekly
|
||||||
|
groups:
|
||||||
|
npm:
|
||||||
|
patterns:
|
||||||
|
- "*"
|
||||||
|
ignore:
|
||||||
|
- dependency-name: node-fetch
|
||||||
|
versions:
|
||||||
|
- ">=3.0.0"
|
||||||
|
# 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: "/"
|
||||||
|
schedule:
|
||||||
|
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:
|
||||||
|
- "*"
|
49
.github/workflows/main.yml
vendored
49
.github/workflows/main.yml
vendored
@ -1,33 +1,32 @@
|
|||||||
name: Main
|
name: main
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
pull_request:
|
||||||
- 'master'
|
|
||||||
|
|
||||||
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@master
|
- uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
node-version-file: ".tool-versions"
|
||||||
# https://github.com/actions/docker/tree/master/cli
|
cache: "npm"
|
||||||
- name: Package
|
|
||||||
uses: actions/docker/cli@master
|
- name: Install
|
||||||
with:
|
run: npm ci
|
||||||
args: build -t ${{ github.repository }}:latest -t ${{ github.repository }}:${{ github.sha }} .
|
- name: Build
|
||||||
# https://github.com/actions/docker/tree/master/login
|
run: npm run build
|
||||||
- name: Publish Auth
|
- name: Test
|
||||||
uses: actions/docker/login@master
|
run: npm run test
|
||||||
env:
|
- name: Format
|
||||||
# https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables
|
run: npm run fmtcheck
|
||||||
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
# - name: "check for uncommitted changes"
|
||||||
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
|
# # Ensure no changes, but ignore node_modules dir since dev/fresh ci deps installed.
|
||||||
# https://github.com/actions/docker/tree/master/cli
|
# run: |
|
||||||
- name: Publish
|
# git diff --exit-code --stat -- . ':!node_modules' \
|
||||||
uses: actions/docker/cli@master
|
# || (echo "##[error] found changed files after build. please 'npm run build && npm run fmt'" \
|
||||||
with:
|
# "and check in all changes" \
|
||||||
args: push ${{ github.repository }}:latest
|
# && exit 1)
|
||||||
|
6
.gitignore
vendored
6
.gitignore
vendored
@ -1,2 +1,4 @@
|
|||||||
/target
|
__tests__/runner/*
|
||||||
**/*.rs.bk
|
# actions requires a node_modules dir https://github.com/actions/toolkit/blob/master/docs/javascript-action.md#publish-a-releasesv1-action
|
||||||
|
# but its recommended not to check these in https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#recommendations
|
||||||
|
node_modules
|
||||||
|
1
.tool-versions
Normal file
1
.tool-versions
Normal file
@ -0,0 +1 @@
|
|||||||
|
nodejs 20.15.1
|
217
CHANGELOG.md
Normal file
217
CHANGELOG.md
Normal file
@ -0,0 +1,217 @@
|
|||||||
|
## 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
|
||||||
|
|
||||||
|
- 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)
|
||||||
|
- Improvements to error handling [#449](https://github.com/softprops/action-gh-release/pull/449) via [@till](https://github.com/till)
|
||||||
|
|
||||||
|
## 2.0.4
|
||||||
|
|
||||||
|
- Minor follow up to [#417](https://github.com/softprops/action-gh-release/pull/417). [#425](https://github.com/softprops/action-gh-release/pull/425)
|
||||||
|
|
||||||
|
## 2.0.3
|
||||||
|
|
||||||
|
- Declare `make_latest` as an input field in `action.yml` [#419](https://github.com/softprops/action-gh-release/pull/419)
|
||||||
|
|
||||||
|
## 2.0.2
|
||||||
|
|
||||||
|
- Revisit approach to [#384](https://github.com/softprops/action-gh-release/pull/384) making unresolved pattern failures opt-in [#417](https://github.com/softprops/action-gh-release/pull/417)
|
||||||
|
|
||||||
|
## 2.0.1
|
||||||
|
|
||||||
|
- Add support for make_latest property [#304](https://github.com/softprops/action-gh-release/pull/304) via [@samueljseay](https://github.com/samueljseay)
|
||||||
|
- Fail run if files setting contains invalid patterns [#384](https://github.com/softprops/action-gh-release/pull/384) via [@rpdelaney](https://github.com/rpdelaney)
|
||||||
|
- Add support for proxy env variables (don't use node-fetch) [#386](https://github.com/softprops/action-gh-release/pull/386/) via [@timor-raiman](https://github.com/timor-raiman)
|
||||||
|
- Suppress confusing warning when input_files is empty [#389](https://github.com/softprops/action-gh-release/pull/389) via [@Drowze](https://github.com/Drowze)
|
||||||
|
|
||||||
|
## 2.0.0
|
||||||
|
|
||||||
|
- `2.0.0`!? this release corrects a disjunction between git tag versions used in the marketplace and versions list this file. Previous versions should have really been 1.\*. Going forward this should be better aligned.
|
||||||
|
- Upgrade action.yml declaration to node20 to address deprecations
|
||||||
|
|
||||||
|
## 0.1.15
|
||||||
|
|
||||||
|
- Upgrade to action.yml declaration to node16 to address deprecations
|
||||||
|
- Upgrade dependencies
|
||||||
|
- Add `asset` output as a JSON array containing information about the uploaded assets
|
||||||
|
|
||||||
|
## 0.1.14
|
||||||
|
|
||||||
|
- provides an new workflow input option `generate_release_notes` which when set to true will automatically generate release notes for you based on GitHub activity [#179](https://github.com/softprops/action-gh-release/pull/179). Please see the [GitHub docs for this feature](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) for more information
|
||||||
|
|
||||||
|
## 0.1.13
|
||||||
|
|
||||||
|
- fix issue with multiple runs concatenating release bodies [#145](https://github.com/softprops/action-gh-release/pull/145)
|
||||||
|
|
||||||
|
## 0.1.12
|
||||||
|
|
||||||
|
- fix bug leading to empty strings subsituted for inputs users don't provide breaking api calls [#144](https://github.com/softprops/action-gh-release/pull/144)
|
||||||
|
|
||||||
|
## 0.1.11
|
||||||
|
|
||||||
|
- better error message on release create failed [#143](https://github.com/softprops/action-gh-release/pull/143)
|
||||||
|
|
||||||
|
## 0.1.10
|
||||||
|
|
||||||
|
- fixed error message formatting for file uploads
|
||||||
|
|
||||||
|
## 0.1.9
|
||||||
|
|
||||||
|
- add support for linking release to GitHub discussion [#136](https://github.com/softprops/action-gh-release/pull/136)
|
||||||
|
|
||||||
|
## 0.1.8
|
||||||
|
|
||||||
|
- address recent warnings in assert upload api as well as introduce asset upload overrides, allowing for multiple runs for the same release with the same named asserts [#134](https://github.com/softprops/action-gh-release/pull/134)
|
||||||
|
- fix backwards compatibility with `GITHUB_TOKEN` resolution. `GITHUB_TOKEN` is no resolved first from an env varibale and then from and input [#133](https://github.com/softprops/action-gh-release/pull/133)
|
||||||
|
- trim white space in provided `tag_name` [#130](https://github.com/softprops/action-gh-release/pull/130)
|
||||||
|
|
||||||
|
## 0.1.7
|
||||||
|
|
||||||
|
- allow creating draft releases without a tag [#95](https://github.com/softprops/action-gh-release/pull/95)
|
||||||
|
- Set default token for simpler setup [#83](https://github.com/softprops/action-gh-release/pull/83)
|
||||||
|
- fix regression with action yml [#126](https://github.com/softprops/action-gh-release/pull/126)
|
||||||
|
|
||||||
|
## 0.1.6
|
||||||
|
|
||||||
|
This is a release catch up have a hiatus. Future releases will happen more frequently
|
||||||
|
|
||||||
|
- Add 'fail_on_unmatched_files' input, useful for catching cases were your `files` input does not actually match what you expect [#55](https://github.com/softprops/action-gh-release/pull/55)
|
||||||
|
- Add `repository` input, useful for creating a release in an external repository [#61](https://github.com/softprops/action-gh-release/pull/61)
|
||||||
|
- Add release `id` to outputs, useful for refering to release in workflow steps following the step that uses this action [#60](https://github.com/softprops/action-gh-release/pull/60)
|
||||||
|
- Add `upload_url` as action output, useful for managing uploads separately [#75](https://github.com/softprops/action-gh-release/pull/75)
|
||||||
|
- Support custom `target_commitish` value, useful to customize the default [#76](https://github.com/softprops/action-gh-release/pull/76)
|
||||||
|
- fix `body_path` input first then fall back on `body` input. this was the originally documented precedence but was implemened the the opposite order! [#85](https://github.com/softprops/action-gh-release/pull/85)
|
||||||
|
- Retain original release info if the keys are not set, useful for filling in blanks for a release you've already started separately [#109](https://github.com/softprops/action-gh-release/pull/109)
|
||||||
|
- Limit number of times github api request to create a release is retried, useful for avoiding eating up your rate limit and action minutes do to either an invalid token or other circumstance causing the api call to fail [#111](https://github.com/softprops/action-gh-release/pull/111)
|
||||||
|
|
||||||
|
## 0.1.5
|
||||||
|
|
||||||
|
- Added support for specifying tag name [#39](https://github.com/softprops/action-gh-release/pull/39)
|
||||||
|
|
||||||
|
## 0.1.4
|
||||||
|
|
||||||
|
- Added support for updating releases body [#36](https://github.com/softprops/action-gh-release/pull/36)
|
||||||
|
- Steps can now access the url of releases with the `url` output of this Action [#28](https://github.com/softprops/action-gh-release/pull/28)
|
||||||
|
- Added basic GitHub API retry support to manage API turbulance [#26](https://github.com/softprops/action-gh-release/pull/26)
|
||||||
|
|
||||||
|
## 0.1.3
|
||||||
|
|
||||||
|
- Fixed where `with: body_path` was not being used in generated GitHub releases
|
||||||
|
|
||||||
|
## 0.1.2
|
||||||
|
|
||||||
|
- Add support for merging draft releases [#16](https://github.com/softprops/action-gh-release/pull/16)
|
||||||
|
|
||||||
|
GitHub's api doesn't explicitly have a way of fetching a draft release by tag name which caused draft releases to appear as separate releases when used in a build matrix.
|
||||||
|
This is now fixed.
|
||||||
|
|
||||||
|
- Add support for newline-delimited asset list [#18](https://github.com/softprops/action-gh-release/pull/18)
|
||||||
|
|
||||||
|
GitHub actions inputs don't inherently support lists of things and one might like to append a list of files to include in a release. Previously this was possible using a comma-delimited list of asset path patterns to upload. You can now provide these as a newline delimieted list for better readability
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: Release
|
||||||
|
uses: softprops/action-gh-release@v1
|
||||||
|
if: startsWith(github.ref, 'refs/tags/')
|
||||||
|
with:
|
||||||
|
files: |
|
||||||
|
filea.txt
|
||||||
|
fileb.txt
|
||||||
|
filec.txt
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Add support for prerelease annotated GitHub releases with the new input field `with.prerelease: true` [#19](https://github.com/softprops/action-gh-release/pull/19)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 0.1.1
|
||||||
|
|
||||||
|
- Add support for publishing releases on all supported virtual hosts
|
||||||
|
|
||||||
|
You'll need to remove `docker://` prefix and use the `@v1` action tag
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 0.1.0
|
||||||
|
|
||||||
|
- Initial release
|
17
CONTRIBUTING.md
Normal file
17
CONTRIBUTING.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
## bootstrapping
|
||||||
|
|
||||||
|
This a [JavaScript](https://help.github.com/en/articles/about-actions#types-of-actions) action but uses [TypeScript](https://www.typescriptlang.org/docs/home.html) to generate that JavaScript.
|
||||||
|
|
||||||
|
You can bootstrap your environment with a modern version of npm and by running `npm i` at the root of this repo.
|
||||||
|
|
||||||
|
## testing
|
||||||
|
|
||||||
|
Tests can be found under under `__tests__` directory and are runnable with the `npm t` command.
|
||||||
|
|
||||||
|
## source code
|
||||||
|
|
||||||
|
Source code can be found under the `src` directory. Running `npm run build` will generate the JavaScript that will run within GitHub workflows.
|
||||||
|
|
||||||
|
## formatting
|
||||||
|
|
||||||
|
A minimal attempt at keeping a consistent code style is can be applied by running `npm run fmt`.
|
1854
Cargo.lock
generated
1854
Cargo.lock
generated
File diff suppressed because it is too large
Load Diff
20
Cargo.toml
20
Cargo.toml
@ -1,20 +0,0 @@
|
|||||||
[package]
|
|
||||||
name = "action-gh-release"
|
|
||||||
version = "0.1.0"
|
|
||||||
authors = ["softprops <d.tangren@gmail.com>"]
|
|
||||||
edition = "2018"
|
|
||||||
|
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
|
||||||
|
|
||||||
[dependencies]
|
|
||||||
mime = "0.3"
|
|
||||||
mime_guess = "2.0"
|
|
||||||
env_logger = "0.6"
|
|
||||||
log = "0.4"
|
|
||||||
glob = "0.3"
|
|
||||||
envy = "0.4"
|
|
||||||
# hack https://docs.rs/openssl/0.10.24/openssl/#vendored
|
|
||||||
openssl = { version = "0.10", features = ["vendored"] }
|
|
||||||
reqwest = { version = "0.9", features = ["rustls-tls"] }
|
|
||||||
serde = { version = "1.0", features = ["derive"] }
|
|
||||||
serde_json = "1.0"
|
|
42
Dockerfile
42
Dockerfile
@ -1,42 +0,0 @@
|
|||||||
# https://hub.docker.com/_/rust?tab=tags
|
|
||||||
FROM rust:1.37.0 as builder
|
|
||||||
|
|
||||||
# musl-gcc
|
|
||||||
RUN apt-get update \
|
|
||||||
&& apt-get install -y \
|
|
||||||
musl-dev \
|
|
||||||
musl-tools \
|
|
||||||
ca-certificates \
|
|
||||||
&& apt-get clean \
|
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
|
||||||
|
|
||||||
WORKDIR /app
|
|
||||||
RUN rustup target add x86_64-unknown-linux-musl
|
|
||||||
# cache deps https://blog.jawg.io/docker-multi-stage-build/
|
|
||||||
# RUN USER=root cargo init
|
|
||||||
# COPY Cargo.toml .
|
|
||||||
# RUN cargo build --target x86_64-unknown-linux-musl --release
|
|
||||||
# COPY src src
|
|
||||||
COPY . .
|
|
||||||
RUN cargo build --target x86_64-unknown-linux-musl --release
|
|
||||||
RUN strip /app/target/x86_64-unknown-linux-musl/release/action-gh-release
|
|
||||||
|
|
||||||
FROM scratch
|
|
||||||
|
|
||||||
# https://help.github.com/en/articles/metadata-syntax-for-github-actions#about-yaml-syntax-for-github-actions
|
|
||||||
LABEL version="0.1.0" \
|
|
||||||
repository="https://github.com/meetup/action-gh-release/" \
|
|
||||||
homepage="https://github.com/meetup/action-gh-release" \
|
|
||||||
maintainer="Meetup" \
|
|
||||||
"com.github.actions.name"="GH-Release" \
|
|
||||||
"com.github.actions.description"="Creates a new Github Release" \
|
|
||||||
"com.github.actions.icon"="package" \
|
|
||||||
"com.github.actions.color"="green"
|
|
||||||
|
|
||||||
COPY --from=builder \
|
|
||||||
/etc/ssl/certs/ca-certificates.crt \
|
|
||||||
/etc/ssl/certs/
|
|
||||||
COPY --from=builder \
|
|
||||||
/app/target/x86_64-unknown-linux-musl/release/action-gh-release \
|
|
||||||
/action-gh-release
|
|
||||||
ENTRYPOINT ["/action-gh-release"]
|
|
2
LICENSE
2
LICENSE
@ -1,4 +1,4 @@
|
|||||||
Copyright (c) 2019 Doug Tangren
|
Copyright (c) 2019-current Doug Tangren
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
Permission is hereby granted, free of charge, to any person obtaining
|
||||||
a copy of this software and associated documentation files (the
|
a copy of this software and associated documentation files (the
|
||||||
|
186
README.md
186
README.md
@ -1,9 +1,35 @@
|
|||||||
|
<div align="center">
|
||||||
|
📦 :octocat:
|
||||||
|
</div>
|
||||||
|
<h1 align="center">
|
||||||
|
action gh-release
|
||||||
|
</h1>
|
||||||
|
|
||||||
# action gh-release [](https://github.com/softprops/action-gh-release/actions)
|
<p align="center">
|
||||||
|
A GitHub Action for creating GitHub Releases on Linux, Windows, and macOS virtual environments
|
||||||
|
</p>
|
||||||
|
|
||||||
> A GitHub Action for creating GitHub Releases
|
<div align="center">
|
||||||
|
<img src="demo.png"/>
|
||||||
|
</div>
|
||||||
|
|
||||||
> **⚠️ Note:** To use this action, you must have access to the [GitHub Actions](https://github.com/features/actions) feature. GitHub Actions are currently only available in public beta. You can [apply for the GitHub Actions beta here](https://github.com/features/actions/signup/).
|
<div align="center">
|
||||||
|
<a href="https://github.com/softprops/action-gh-release/actions">
|
||||||
|
<img src="https://github.com/softprops/action-gh-release/workflows/Main/badge.svg"/>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<br />
|
||||||
|
|
||||||
|
- [🤸 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
|
||||||
|
|
||||||
@ -11,7 +37,7 @@
|
|||||||
|
|
||||||
Typically usage of this action involves adding a step to a build that
|
Typically usage of this action involves adding a step to a build that
|
||||||
is gated pushes to git tags. You may find `step.if` field helpful in accomplishing this
|
is gated pushes to git tags. You may find `step.if` field helpful in accomplishing this
|
||||||
as it maximizes the resuse value of your workflow for non-tag pushes.
|
as it maximizes the reuse value of your workflow for non-tag pushes.
|
||||||
|
|
||||||
Below is a simple example of `step.if` tag gating
|
Below is a simple example of `step.if` tag gating
|
||||||
|
|
||||||
@ -25,23 +51,41 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@master
|
uses: actions/checkout@v4
|
||||||
- name: Release
|
- name: Release
|
||||||
uses: docker://softprops/action-gh-release
|
uses: softprops/action-gh-release@v2
|
||||||
if: startsWith(github.ref, 'refs/tags/')
|
if: github.ref_type == 'tag'
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You can also use push config tag filter
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: Main
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "v*.*.*"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Release
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
```
|
||||||
|
|
||||||
### ⬆️ Uploading release assets
|
### ⬆️ Uploading release assets
|
||||||
|
|
||||||
You can can configure a number of options for your
|
You can configure a number of options for your
|
||||||
GitHub release and all are optional.
|
GitHub release and all are optional.
|
||||||
|
|
||||||
A common case for GitHub releases is to upload your binary after its been validated and packaged.
|
A common case for GitHub releases is to upload your binary after its been validated and packaged.
|
||||||
Use the `with.files` input to declare a comma-separated list of glob expressions matching the files
|
Use the `with.files` input to declare a newline-delimited list of glob expressions matching the files
|
||||||
you wish to upload to GitHub releases. If you'd like you can just list the files by name directly.
|
you wish to upload to GitHub releases. If you'd like you can just list the files by name directly.
|
||||||
|
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`
|
||||||
|
|
||||||
@ -55,20 +99,48 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@master
|
uses: actions/checkout@v4
|
||||||
- name: Build
|
- name: Build
|
||||||
run: echo ${{ github.sha }} > Release.txt
|
run: echo ${{ github.sha }} > Release.txt
|
||||||
- name: Test
|
- name: Test
|
||||||
run: cat Release.txt
|
run: cat Release.txt
|
||||||
- name: Release
|
- name: Release
|
||||||
uses: docker://softprops/action-gh-release
|
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
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Below is an example of uploading more than one asset with a GitHub release
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: Main
|
||||||
|
|
||||||
|
on: push
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Build
|
||||||
|
run: echo ${{ github.sha }} > Release.txt
|
||||||
|
- name: Test
|
||||||
|
run: cat Release.txt
|
||||||
|
- name: Release
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
if: github.ref_type == 'tag'
|
||||||
|
with:
|
||||||
|
files: |
|
||||||
|
Release.txt
|
||||||
|
LICENSE
|
||||||
|
```
|
||||||
|
|
||||||
|
> **⚠️ Note:** Notice the `|` in the yaml syntax above ☝️. That lets you effectively declare a multi-line yaml string. You can learn more about multi-line yaml syntax [here](https://yaml-multiline.info)
|
||||||
|
|
||||||
|
> **⚠️ Note for Windows:** Paths must use `/` as a separator, not `\`, as `\` is used to escape characters with special meaning in the pattern; for example, instead of specifying `D:\Foo.txt`, you must specify `D:/Foo.txt`. If you're using PowerShell, you can do this with `$Path = $Path -replace '\\','/'`
|
||||||
|
|
||||||
### 📝 External release notes
|
### 📝 External release notes
|
||||||
|
|
||||||
Many systems exist that can help generate release notes for you. This action supports
|
Many systems exist that can help generate release notes for you. This action supports
|
||||||
@ -85,16 +157,18 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@master
|
uses: actions/checkout@v4
|
||||||
- name: Generate Changeload
|
- name: Generate Changelog
|
||||||
run: echo "# Good things have arrived" > ${{ github.workflow }}-CHANGELOG.txt
|
run: echo "# Good things have arrived" > ${{ github.workspace }}-CHANGELOG.txt
|
||||||
- name: Release
|
- name: Release
|
||||||
uses: docker://softprops/action-gh-release
|
uses: softprops/action-gh-release@v2
|
||||||
if: startsWith(github.ref, 'refs/tags/')
|
if: github.ref_type == 'tag'
|
||||||
with:
|
with:
|
||||||
body_path: ${{ github.workflow }}-CHANGELOG.txt
|
body_path: ${{ github.workspace }}-CHANGELOG.txt
|
||||||
env:
|
repository: my_gh_org/my_gh_repo
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
# note you'll typically need to create a personal access token
|
||||||
|
# with permissions to create releases in the other repo
|
||||||
|
token: ${{ secrets.CUSTOM_GITHUB_TOKEN }}
|
||||||
```
|
```
|
||||||
|
|
||||||
### 💅 Customizing
|
### 💅 Customizing
|
||||||
@ -104,21 +178,75 @@ jobs:
|
|||||||
The following are optional as `step.with` keys
|
The following are optional as `step.with` keys
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
|-------------|---------|-----------------------------------------------------------------|
|
| -------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `body` | String | Text communicating notable changes in this release |
|
| `body` | String | Text communicating notable changes in this release |
|
||||||
| `body_path` | String | Path to load text communicating notable changes in this release |
|
| `body_path` | String | Path to load text communicating notable changes in this release |
|
||||||
| `draft` | Boolean | Indicator of whether or not this release is a draft |
|
| `draft` | Boolean | Indicator of whether or not this release is a draft |
|
||||||
| `files` | String | Comma-delimited globs of paths to assets to upload for release |
|
| `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 |
|
||||||
| `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` |
|
||||||
|
| `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 |
|
||||||
|
| `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. |
|
||||||
|
| `token` | String | Secret GitHub Personal Access Token. Defaults to `${{ github.token }}` |
|
||||||
|
| `discussion_category_name` | String | If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see ["Managing categories for discussions in your repository."](https://docs.github.com/en/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository) |
|
||||||
|
| `generate_release_notes` | Boolean | Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes. See the [GitHub docs for this feature](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) for more information |
|
||||||
|
| `append_body` | Boolean | Append to existing body instead of overwriting it |
|
||||||
|
| `make_latest` | String | 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 defaults if not provided |
|
||||||
|
|
||||||
💡When providing a `body` and `body_path` at the same time, `body_path` will be attempted first, then falling back on `body` if the path can not be read from.
|
💡 When providing a `body` and `body_path` at the same time, `body_path` will be
|
||||||
|
attempted first, then falling back on `body` if the path can not be read from.
|
||||||
|
|
||||||
|
💡 When the release info keys (such as `name`, `body`, `draft`, `prerelease`, etc.)
|
||||||
|
are not explicitly set and there is already an existing release for the tag, the
|
||||||
|
release will retain its original info.
|
||||||
|
|
||||||
|
#### outputs
|
||||||
|
|
||||||
|
The following outputs can be accessed via `${{ steps.<step-id>.outputs }}` from this action
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `url` | String | Github.com URL for the release |
|
||||||
|
| `id` | String | Release ID |
|
||||||
|
| `upload_url` | String | URL for uploading assets to the release |
|
||||||
|
| `assets` | String | JSON array containing information about each uploaded asset, in the format given [here](https://docs.github.com/en/rest/releases/assets#get-a-release-asset) (minus the `uploader` field) |
|
||||||
|
|
||||||
|
As an example, you can use `${{ fromJSON(steps.<step-id>.outputs.assets)[0].browser_download_url }}` to get the download URL of the first asset.
|
||||||
|
|
||||||
#### environment variables
|
#### environment variables
|
||||||
|
|
||||||
The following are *required* as `step.env` keys
|
The following `step.env` keys are allowed as a fallback but deprecated in favor of using inputs.
|
||||||
|
|
||||||
| Name | Description |
|
| Name | Description |
|
||||||
|----------------|--------------------------------------|
|
| ------------------- | ------------------------------------------------------------------------------------------ |
|
||||||
| `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets` |
|
| `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets` |
|
||||||
|
| `GITHUB_REPOSITORY` | Name of a target repository in `<owner>/<repo>` format. defaults to the current repository |
|
||||||
|
|
||||||
|
> **⚠️ Note:** This action was previously implemented as a Docker container, limiting its use to GitHub Actions Linux virtual environments only. With recent releases, we now support cross platform usage. You'll need to remove the `docker://` prefix in these versions
|
||||||
|
|
||||||
|
### Permissions
|
||||||
|
|
||||||
|
This Action requires the following permissions on the GitHub integration token:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
```
|
||||||
|
|
||||||
|
When used with `discussion_category_name`, additional permission is needed:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
discussions: write
|
||||||
|
```
|
||||||
|
|
||||||
|
[GitHub token permissions](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) can be set for an individual job, workflow, or for Actions as a whole.
|
||||||
|
|
||||||
|
Note that if you intend to run workflows on the release event (`on: { release: { types: [published] } }`), you need to use
|
||||||
|
a personal access token for this action, as the [default `secrets.GITHUB_TOKEN` does not trigger another workflow](https://github.com/actions/create-release/issues/71).
|
||||||
|
|
||||||
Doug Tangren (softprops) 2019
|
Doug Tangren (softprops) 2019
|
23
__tests__/github.test.ts
Normal file
23
__tests__/github.test.ts
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
import * as assert from "assert";
|
||||||
|
import { text } from "stream/consumers";
|
||||||
|
import { mimeOrDefault, asset } from "../src/github";
|
||||||
|
|
||||||
|
describe("github", () => {
|
||||||
|
describe("mimeOrDefault", () => {
|
||||||
|
it("returns a specific mime for common path", async () => {
|
||||||
|
assert.equal(mimeOrDefault("foo.tar.gz"), "application/gzip");
|
||||||
|
});
|
||||||
|
it("returns default mime for uncommon path", async () => {
|
||||||
|
assert.equal(mimeOrDefault("foo.uncommon"), "application/octet-stream");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("asset", () => {
|
||||||
|
it("derives asset info from a path", async () => {
|
||||||
|
const { name, mime, size } = asset("tests/data/foo/bar.txt");
|
||||||
|
assert.equal(name, "bar.txt");
|
||||||
|
assert.equal(mime, "text/plain");
|
||||||
|
assert.equal(size, 10);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
1
__tests__/release.txt
Normal file
1
__tests__/release.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
bar
|
401
__tests__/util.test.ts
Normal file
401
__tests__/util.test.ts
Normal file
@ -0,0 +1,401 @@
|
|||||||
|
import {
|
||||||
|
releaseBody,
|
||||||
|
isTag,
|
||||||
|
paths,
|
||||||
|
parseConfig,
|
||||||
|
parseInputFiles,
|
||||||
|
unmatchedPatterns,
|
||||||
|
uploadUrl,
|
||||||
|
alignAssetName,
|
||||||
|
} from "../src/util";
|
||||||
|
import * as assert from "assert";
|
||||||
|
|
||||||
|
describe("util", () => {
|
||||||
|
describe("uploadUrl", () => {
|
||||||
|
it("strips template", () => {
|
||||||
|
assert.equal(
|
||||||
|
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",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe("parseInputFiles", () => {
|
||||||
|
it("parses empty strings", () => {
|
||||||
|
assert.deepStrictEqual(parseInputFiles(""), []);
|
||||||
|
});
|
||||||
|
it("parses comma-delimited strings", () => {
|
||||||
|
assert.deepStrictEqual(parseInputFiles("foo,bar"), ["foo", "bar"]);
|
||||||
|
});
|
||||||
|
it("parses newline and comma-delimited (and then some)", () => {
|
||||||
|
assert.deepStrictEqual(
|
||||||
|
parseInputFiles("foo,bar\nbaz,boom,\n\ndoom,loom "),
|
||||||
|
["foo", "bar", "baz", "boom", "doom", "loom"],
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe("releaseBody", () => {
|
||||||
|
it("uses input body", () => {
|
||||||
|
assert.equal(
|
||||||
|
"foo",
|
||||||
|
releaseBody({
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "",
|
||||||
|
input_body: "foo",
|
||||||
|
input_body_path: undefined,
|
||||||
|
input_draft: false,
|
||||||
|
input_prerelease: false,
|
||||||
|
input_preserve_order: undefined,
|
||||||
|
input_files: [],
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_target_commitish: undefined,
|
||||||
|
input_discussion_category_name: undefined,
|
||||||
|
input_generate_release_notes: false,
|
||||||
|
input_make_latest: undefined,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
it("uses input body path", () => {
|
||||||
|
assert.equal(
|
||||||
|
"bar",
|
||||||
|
releaseBody({
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "",
|
||||||
|
input_body: undefined,
|
||||||
|
input_body_path: "__tests__/release.txt",
|
||||||
|
input_draft: false,
|
||||||
|
input_prerelease: false,
|
||||||
|
input_preserve_order: undefined,
|
||||||
|
input_files: [],
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_target_commitish: undefined,
|
||||||
|
input_discussion_category_name: undefined,
|
||||||
|
input_generate_release_notes: false,
|
||||||
|
input_make_latest: undefined,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
it("defaults to body path when both body and body path are provided", () => {
|
||||||
|
assert.equal(
|
||||||
|
"bar",
|
||||||
|
releaseBody({
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "",
|
||||||
|
input_body: "foo",
|
||||||
|
input_body_path: "__tests__/release.txt",
|
||||||
|
input_draft: false,
|
||||||
|
input_prerelease: false,
|
||||||
|
input_preserve_order: undefined,
|
||||||
|
input_files: [],
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_target_commitish: undefined,
|
||||||
|
input_discussion_category_name: undefined,
|
||||||
|
input_generate_release_notes: false,
|
||||||
|
input_make_latest: undefined,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe("parseConfig", () => {
|
||||||
|
it("parses basic config", () => {
|
||||||
|
assert.deepStrictEqual(
|
||||||
|
parseConfig({
|
||||||
|
// note: inputs declared in actions.yml, even when declared not required,
|
||||||
|
// are still provided by the actions runtime env as empty strings instead of
|
||||||
|
// the normal absent env value one would expect. this breaks things
|
||||||
|
// 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
|
||||||
|
// resolved as undefined and not empty strings
|
||||||
|
INPUT_TARGET_COMMITISH: "",
|
||||||
|
INPUT_DISCUSSION_CATEGORY_NAME: "",
|
||||||
|
}),
|
||||||
|
{
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "",
|
||||||
|
input_append_body: false,
|
||||||
|
input_body: undefined,
|
||||||
|
input_body_path: undefined,
|
||||||
|
input_draft: undefined,
|
||||||
|
input_prerelease: undefined,
|
||||||
|
input_preserve_order: undefined,
|
||||||
|
input_files: [],
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_fail_on_unmatched_files: false,
|
||||||
|
input_target_commitish: undefined,
|
||||||
|
input_discussion_category_name: undefined,
|
||||||
|
input_generate_release_notes: false,
|
||||||
|
input_make_latest: undefined,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("parses basic config with commitish", () => {
|
||||||
|
assert.deepStrictEqual(
|
||||||
|
parseConfig({
|
||||||
|
INPUT_TARGET_COMMITISH: "affa18ef97bc9db20076945705aba8c516139abd",
|
||||||
|
}),
|
||||||
|
{
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "",
|
||||||
|
input_append_body: false,
|
||||||
|
input_body: undefined,
|
||||||
|
input_body_path: undefined,
|
||||||
|
input_draft: undefined,
|
||||||
|
input_prerelease: undefined,
|
||||||
|
input_files: [],
|
||||||
|
input_preserve_order: undefined,
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_fail_on_unmatched_files: false,
|
||||||
|
input_target_commitish: "affa18ef97bc9db20076945705aba8c516139abd",
|
||||||
|
input_discussion_category_name: undefined,
|
||||||
|
input_generate_release_notes: false,
|
||||||
|
input_make_latest: undefined,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
it("supports discussion category names", () => {
|
||||||
|
assert.deepStrictEqual(
|
||||||
|
parseConfig({
|
||||||
|
INPUT_DISCUSSION_CATEGORY_NAME: "releases",
|
||||||
|
}),
|
||||||
|
{
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "",
|
||||||
|
input_append_body: false,
|
||||||
|
input_body: undefined,
|
||||||
|
input_body_path: undefined,
|
||||||
|
input_draft: undefined,
|
||||||
|
input_prerelease: undefined,
|
||||||
|
input_files: [],
|
||||||
|
input_preserve_order: undefined,
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_fail_on_unmatched_files: false,
|
||||||
|
input_target_commitish: undefined,
|
||||||
|
input_discussion_category_name: "releases",
|
||||||
|
input_generate_release_notes: false,
|
||||||
|
input_make_latest: undefined,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("supports generating release notes", () => {
|
||||||
|
assert.deepStrictEqual(
|
||||||
|
parseConfig({
|
||||||
|
INPUT_GENERATE_RELEASE_NOTES: "true",
|
||||||
|
}),
|
||||||
|
{
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "",
|
||||||
|
input_append_body: false,
|
||||||
|
input_body: undefined,
|
||||||
|
input_body_path: undefined,
|
||||||
|
input_draft: undefined,
|
||||||
|
input_prerelease: undefined,
|
||||||
|
input_preserve_order: undefined,
|
||||||
|
input_files: [],
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_fail_on_unmatched_files: false,
|
||||||
|
input_target_commitish: undefined,
|
||||||
|
input_discussion_category_name: undefined,
|
||||||
|
input_generate_release_notes: true,
|
||||||
|
input_make_latest: undefined,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("prefers GITHUB_TOKEN over token input for backwards compatibility", () => {
|
||||||
|
assert.deepStrictEqual(
|
||||||
|
parseConfig({
|
||||||
|
INPUT_DRAFT: "false",
|
||||||
|
INPUT_PRERELEASE: "true",
|
||||||
|
INPUT_PRESERVE_ORDER: "true",
|
||||||
|
GITHUB_TOKEN: "env-token",
|
||||||
|
INPUT_TOKEN: "input-token",
|
||||||
|
}),
|
||||||
|
{
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "env-token",
|
||||||
|
input_append_body: false,
|
||||||
|
input_body: undefined,
|
||||||
|
input_body_path: undefined,
|
||||||
|
input_draft: false,
|
||||||
|
input_prerelease: true,
|
||||||
|
input_preserve_order: true,
|
||||||
|
input_files: [],
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_fail_on_unmatched_files: false,
|
||||||
|
input_target_commitish: undefined,
|
||||||
|
input_discussion_category_name: undefined,
|
||||||
|
input_generate_release_notes: false,
|
||||||
|
input_make_latest: undefined,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
it("uses input token as the source of GITHUB_TOKEN by default", () => {
|
||||||
|
assert.deepStrictEqual(
|
||||||
|
parseConfig({
|
||||||
|
INPUT_DRAFT: "false",
|
||||||
|
INPUT_PRERELEASE: "true",
|
||||||
|
INPUT_TOKEN: "input-token",
|
||||||
|
}),
|
||||||
|
{
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "input-token",
|
||||||
|
input_append_body: false,
|
||||||
|
input_body: undefined,
|
||||||
|
input_body_path: undefined,
|
||||||
|
input_draft: false,
|
||||||
|
input_prerelease: true,
|
||||||
|
input_preserve_order: undefined,
|
||||||
|
input_files: [],
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_fail_on_unmatched_files: false,
|
||||||
|
input_target_commitish: undefined,
|
||||||
|
input_discussion_category_name: undefined,
|
||||||
|
input_generate_release_notes: false,
|
||||||
|
input_make_latest: undefined,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
it("parses basic config with draft and prerelease", () => {
|
||||||
|
assert.deepStrictEqual(
|
||||||
|
parseConfig({
|
||||||
|
INPUT_DRAFT: "false",
|
||||||
|
INPUT_PRERELEASE: "true",
|
||||||
|
}),
|
||||||
|
{
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "",
|
||||||
|
input_append_body: false,
|
||||||
|
input_body: undefined,
|
||||||
|
input_body_path: undefined,
|
||||||
|
input_draft: false,
|
||||||
|
input_prerelease: true,
|
||||||
|
input_preserve_order: undefined,
|
||||||
|
input_files: [],
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_fail_on_unmatched_files: false,
|
||||||
|
input_target_commitish: undefined,
|
||||||
|
input_discussion_category_name: undefined,
|
||||||
|
input_generate_release_notes: false,
|
||||||
|
input_make_latest: undefined,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
it("parses basic config where make_latest is passed", () => {
|
||||||
|
assert.deepStrictEqual(
|
||||||
|
parseConfig({
|
||||||
|
INPUT_MAKE_LATEST: "false",
|
||||||
|
}),
|
||||||
|
{
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "",
|
||||||
|
input_append_body: false,
|
||||||
|
input_body: undefined,
|
||||||
|
input_body_path: undefined,
|
||||||
|
input_draft: undefined,
|
||||||
|
input_prerelease: undefined,
|
||||||
|
input_preserve_order: undefined,
|
||||||
|
input_files: [],
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_fail_on_unmatched_files: false,
|
||||||
|
input_target_commitish: undefined,
|
||||||
|
input_discussion_category_name: undefined,
|
||||||
|
input_generate_release_notes: false,
|
||||||
|
input_make_latest: "false",
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
it("parses basic config with append_body", () => {
|
||||||
|
assert.deepStrictEqual(
|
||||||
|
parseConfig({
|
||||||
|
INPUT_APPEND_BODY: "true",
|
||||||
|
}),
|
||||||
|
{
|
||||||
|
github_ref: "",
|
||||||
|
github_repository: "",
|
||||||
|
github_token: "",
|
||||||
|
input_append_body: true,
|
||||||
|
input_body: undefined,
|
||||||
|
input_body_path: undefined,
|
||||||
|
input_draft: undefined,
|
||||||
|
input_prerelease: undefined,
|
||||||
|
input_preserve_order: undefined,
|
||||||
|
input_files: [],
|
||||||
|
input_name: undefined,
|
||||||
|
input_tag_name: undefined,
|
||||||
|
input_fail_on_unmatched_files: false,
|
||||||
|
input_target_commitish: undefined,
|
||||||
|
input_discussion_category_name: undefined,
|
||||||
|
input_generate_release_notes: false,
|
||||||
|
input_make_latest: undefined,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe("isTag", () => {
|
||||||
|
it("returns true for tags", async () => {
|
||||||
|
assert.equal(isTag("refs/tags/foo"), true);
|
||||||
|
});
|
||||||
|
it("returns false for other kinds of refs", async () => {
|
||||||
|
assert.equal(isTag("refs/heads/master"), false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("paths", () => {
|
||||||
|
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(
|
||||||
|
unmatchedPatterns(["tests/data/**/*", "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");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
78
action.yml
78
action.yml
@ -1,33 +1,71 @@
|
|||||||
# https://help.github.com/en/articles/metadata-syntax-for-github-actions
|
# https://help.github.com/en/articles/metadata-syntax-for-github-actions
|
||||||
name: 'GH Release'
|
name: "GH Release"
|
||||||
description: 'Github Action for creating Github Releases'
|
description: "Github Action for creating Github Releases"
|
||||||
author: 'softprops'
|
author: "softprops"
|
||||||
inputs:
|
inputs:
|
||||||
body:
|
body:
|
||||||
description: 'Note-worthy description of changes in release'
|
description: "Note-worthy description of changes in release"
|
||||||
required: false
|
required: false
|
||||||
default: 'empty'
|
body_path:
|
||||||
body-path:
|
description: "Path to load note-worthy description of changes in release from"
|
||||||
description: 'Path to load note-worthy description of changes in release from'
|
|
||||||
required: false
|
required: false
|
||||||
default: 'empty'
|
|
||||||
name:
|
name:
|
||||||
description: 'Gives the release a custom name'
|
description: "Gives the release a custom name. Defaults to tag name"
|
||||||
|
required: false
|
||||||
|
tag_name:
|
||||||
|
description: "Gives a tag name. Defaults to github.ref_name"
|
||||||
required: false
|
required: false
|
||||||
default: 'Name of tag'
|
|
||||||
draft:
|
draft:
|
||||||
description: 'Creates a draft release'
|
description: "Creates a draft release. Defaults to false"
|
||||||
|
required: false
|
||||||
|
prerelease:
|
||||||
|
description: "Identify the release as a prerelease. Defaults to false"
|
||||||
|
required: false
|
||||||
|
preserve_order:
|
||||||
|
description: "Preserver the order of the artifacts when uploading"
|
||||||
required: false
|
required: false
|
||||||
default: 'false'
|
|
||||||
files:
|
files:
|
||||||
description: 'Comma-delimited list of path globs for asset files to upload'
|
description: "Newline-delimited list of path globs for asset files to upload"
|
||||||
|
required: false
|
||||||
|
fail_on_unmatched_files:
|
||||||
|
description: "Fails if any of the `files` globs match nothing. Defaults to false"
|
||||||
|
required: false
|
||||||
|
repository:
|
||||||
|
description: "Repository to make releases against, in <owner>/<repo> format"
|
||||||
|
required: false
|
||||||
|
token:
|
||||||
|
description: "Authorized secret GitHub Personal Access Token. Defaults to github.token"
|
||||||
|
required: false
|
||||||
|
default: ${{ github.token }}
|
||||||
|
target_commitish:
|
||||||
|
description: "Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA."
|
||||||
|
required: false
|
||||||
|
discussion_category_name:
|
||||||
|
description: "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored."
|
||||||
|
required: false
|
||||||
|
generate_release_notes:
|
||||||
|
description: "Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes."
|
||||||
|
required: false
|
||||||
|
append_body:
|
||||||
|
description: "Append to existing body instead of overwriting it. Default is false."
|
||||||
|
required: false
|
||||||
|
make_latest:
|
||||||
|
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
|
||||||
default: 'empty'
|
|
||||||
runs:
|
|
||||||
using: 'docker'
|
|
||||||
image: 'docker://softprops:action-gh-action'
|
|
||||||
env:
|
env:
|
||||||
'GITHUB_TOKEN': 'As provided by Github Actions'
|
GITHUB_TOKEN: "As provided by Github Actions"
|
||||||
|
outputs:
|
||||||
|
url:
|
||||||
|
description: "URL to the Release HTML Page"
|
||||||
|
id:
|
||||||
|
description: "Release ID"
|
||||||
|
upload_url:
|
||||||
|
description: "URL for uploading assets to the release"
|
||||||
|
assets:
|
||||||
|
description: "JSON array containing information about each uploaded asset, in the format given [here](https://docs.github.com/en/rest/reference/repos#upload-a-release-asset--code-samples) (minus the `uploader` field)"
|
||||||
|
runs:
|
||||||
|
using: "node20"
|
||||||
|
main: "dist/index.js"
|
||||||
branding:
|
branding:
|
||||||
color: 'green'
|
color: "green"
|
||||||
icon: 'package'
|
icon: "package"
|
||||||
|
3
dist/index.js
vendored
Normal file
3
dist/index.js
vendored
Normal file
File diff suppressed because one or more lines are too long
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;
|
4788
package-lock.json
generated
Normal file
4788
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
45
package.json
Normal file
45
package.json
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
{
|
||||||
|
"name": "action-gh-release",
|
||||||
|
"version": "2.2.1",
|
||||||
|
"private": true,
|
||||||
|
"description": "GitHub Action for creating GitHub Releases",
|
||||||
|
"main": "lib/main.js",
|
||||||
|
"scripts": {
|
||||||
|
"build": "ncc build src/main.ts --minify",
|
||||||
|
"build-debug": "ncc build src/main.ts --v8-cache --source-map",
|
||||||
|
"test": "jest",
|
||||||
|
"fmt": "prettier --write \"src/**/*.ts\" \"__tests__/**/*.ts\"",
|
||||||
|
"fmtcheck": "prettier --check \"src/**/*.ts\" \"__tests__/**/*.ts\"",
|
||||||
|
"updatetag": "git tag -d v2 && git push origin :v2 && git tag -a v2 -m '' && git push origin v2"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/softprops/action-gh-release.git"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"actions"
|
||||||
|
],
|
||||||
|
"author": "softprops",
|
||||||
|
"dependencies": {
|
||||||
|
"@actions/core": "^1.11.1",
|
||||||
|
"@actions/github": "^6.0.0",
|
||||||
|
"@octokit/plugin-retry": "^7.2.0",
|
||||||
|
"@octokit/plugin-throttling": "^9.6.1",
|
||||||
|
"glob": "^11.0.1",
|
||||||
|
"mime": "^3.0.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/glob": "^8.1.0",
|
||||||
|
"@types/jest": "^29.5.14",
|
||||||
|
"@types/mime": "^3.0.1",
|
||||||
|
"@types/node": "^22.14.0",
|
||||||
|
"@vercel/ncc": "^0.38.3",
|
||||||
|
"jest": "^29.3.1",
|
||||||
|
"jest-circus": "^29.3.1",
|
||||||
|
"prettier": "3.5.3",
|
||||||
|
"ts-jest": "^29.3.1",
|
||||||
|
"ts-node": "^10.9.2",
|
||||||
|
"typescript": "^5.8.3",
|
||||||
|
"typescript-formatter": "^7.2.2"
|
||||||
|
}
|
||||||
|
}
|
@ -1,4 +0,0 @@
|
|||||||
# https://github.com/rust-lang/rustfmt/blob/master/Configurations.md#fn_args_layout
|
|
||||||
fn_args_layout = "Vertical"
|
|
||||||
# https://github.com/rust-lang/rustfmt/blob/master/Configurations.md#merge_imports
|
|
||||||
merge_imports = true
|
|
111
src/github.rs
111
src/github.rs
@ -1,111 +0,0 @@
|
|||||||
use mime::Mime;
|
|
||||||
use reqwest::{Body, Client, StatusCode};
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
use std::{error::Error, fs::File};
|
|
||||||
|
|
||||||
#[derive(Serialize, Default, Debug, PartialEq)]
|
|
||||||
pub struct Release {
|
|
||||||
pub tag_name: String,
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub name: Option<String>,
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub body: Option<String>,
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub draft: Option<bool>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Deserialize)]
|
|
||||||
pub struct ReleaseResponse {
|
|
||||||
pub id: usize,
|
|
||||||
pub html_url: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
pub trait Releaser {
|
|
||||||
fn release(
|
|
||||||
&self,
|
|
||||||
github_token: &str,
|
|
||||||
github_repo: &str,
|
|
||||||
release: Release,
|
|
||||||
) -> Result<ReleaseResponse, Box<dyn Error>>;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub trait AssetUploader<A: Into<Body> = File> {
|
|
||||||
fn upload(
|
|
||||||
&self,
|
|
||||||
github_token: &str,
|
|
||||||
github_repo: &str,
|
|
||||||
release_id: usize,
|
|
||||||
name: &str,
|
|
||||||
mime: Mime,
|
|
||||||
asset: A,
|
|
||||||
) -> Result<StatusCode, Box<dyn Error>>;
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Releaser for Client {
|
|
||||||
// https://developer.github.com/v3/repos/releases/#create-a-release
|
|
||||||
// https://developer.github.com/v3/repos/releases/#edit-a-release
|
|
||||||
fn release(
|
|
||||||
&self,
|
|
||||||
github_token: &str,
|
|
||||||
github_repo: &str,
|
|
||||||
release: Release,
|
|
||||||
) -> Result<ReleaseResponse, Box<dyn Error>> {
|
|
||||||
let endpoint = format!("https://api.github.com/repos/{}/releases", github_repo);
|
|
||||||
let mut existing = self
|
|
||||||
.get(&format!("{}/tags/{}", endpoint, release.tag_name))
|
|
||||||
.header("Authorization", format!("bearer {}", github_token))
|
|
||||||
.send()?;
|
|
||||||
match existing.status() {
|
|
||||||
StatusCode::NOT_FOUND => Ok(self
|
|
||||||
.post(&format!(
|
|
||||||
"https://api.github.com/repos/{}/releases",
|
|
||||||
github_repo
|
|
||||||
))
|
|
||||||
.header("Authorization", format!("bearer {}", github_token))
|
|
||||||
.json(&release)
|
|
||||||
.send()?
|
|
||||||
.json()?),
|
|
||||||
_ => Ok(self
|
|
||||||
.patch(&format!(
|
|
||||||
"https://api.github.com/repos/{}/releases/{}",
|
|
||||||
github_repo,
|
|
||||||
existing.json::<ReleaseResponse>()?.id
|
|
||||||
))
|
|
||||||
.header("Authorization", format!("bearer {}", github_token))
|
|
||||||
.json(&release)
|
|
||||||
.send()?
|
|
||||||
.json()?),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<A: Into<Body>> AssetUploader<A> for Client {
|
|
||||||
// https://developer.github.com/v3/repos/releases/#upload-a-release-asset
|
|
||||||
fn upload(
|
|
||||||
&self,
|
|
||||||
github_token: &str,
|
|
||||||
github_repo: &str,
|
|
||||||
release_id: usize,
|
|
||||||
name: &str,
|
|
||||||
mime: mime::Mime,
|
|
||||||
asset: A,
|
|
||||||
) -> Result<StatusCode, Box<dyn Error>> {
|
|
||||||
Ok(self
|
|
||||||
.post(&format!(
|
|
||||||
"https://uploads.github.com/repos/{}/releases/{}/assets",
|
|
||||||
github_repo, release_id
|
|
||||||
))
|
|
||||||
.header("Authorization", format!("bearer {}", github_token))
|
|
||||||
.header("Content-Type", mime.to_string())
|
|
||||||
.query(&[("name", name)])
|
|
||||||
.body(asset)
|
|
||||||
.send()?
|
|
||||||
.status())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
#[test]
|
|
||||||
fn it_works() {}
|
|
||||||
}
|
|
397
src/github.ts
Normal file
397
src/github.ts
Normal file
@ -0,0 +1,397 @@
|
|||||||
|
import { GitHub } from "@actions/github/lib/utils";
|
||||||
|
import { Config, isTag, releaseBody, alignAssetName } from "./util";
|
||||||
|
import { statSync } from "fs";
|
||||||
|
import { open } from "fs/promises";
|
||||||
|
import { getType } from "mime";
|
||||||
|
import { basename } from "path";
|
||||||
|
|
||||||
|
type GitHub = InstanceType<typeof GitHub>;
|
||||||
|
|
||||||
|
export interface ReleaseAsset {
|
||||||
|
name: string;
|
||||||
|
mime: string;
|
||||||
|
size: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Release {
|
||||||
|
id: number;
|
||||||
|
upload_url: string;
|
||||||
|
html_url: string;
|
||||||
|
tag_name: string;
|
||||||
|
name: string | null;
|
||||||
|
body?: string | null | undefined;
|
||||||
|
target_commitish: string;
|
||||||
|
draft: boolean;
|
||||||
|
prerelease: boolean;
|
||||||
|
assets: Array<{ id: number; name: string }>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Releaser {
|
||||||
|
getReleaseByTag(params: {
|
||||||
|
owner: string;
|
||||||
|
repo: string;
|
||||||
|
tag: string;
|
||||||
|
}): Promise<{ data: Release }>;
|
||||||
|
|
||||||
|
createRelease(params: {
|
||||||
|
owner: string;
|
||||||
|
repo: string;
|
||||||
|
tag_name: string;
|
||||||
|
name: string;
|
||||||
|
body: string | undefined;
|
||||||
|
draft: boolean | undefined;
|
||||||
|
prerelease: boolean | undefined;
|
||||||
|
target_commitish: string | undefined;
|
||||||
|
discussion_category_name: string | undefined;
|
||||||
|
generate_release_notes: boolean | undefined;
|
||||||
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
|
}): Promise<{ data: Release }>;
|
||||||
|
|
||||||
|
updateRelease(params: {
|
||||||
|
owner: string;
|
||||||
|
repo: string;
|
||||||
|
release_id: number;
|
||||||
|
tag_name: string;
|
||||||
|
target_commitish: string;
|
||||||
|
name: string;
|
||||||
|
body: string | undefined;
|
||||||
|
draft: boolean | undefined;
|
||||||
|
prerelease: boolean | undefined;
|
||||||
|
discussion_category_name: string | undefined;
|
||||||
|
generate_release_notes: boolean | undefined;
|
||||||
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
|
}): Promise<{ data: Release }>;
|
||||||
|
|
||||||
|
allReleases(params: {
|
||||||
|
owner: string;
|
||||||
|
repo: string;
|
||||||
|
}): AsyncIterableIterator<{ data: Release[] }>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class GitHubReleaser implements Releaser {
|
||||||
|
github: GitHub;
|
||||||
|
constructor(github: GitHub) {
|
||||||
|
this.github = github;
|
||||||
|
}
|
||||||
|
|
||||||
|
getReleaseByTag(params: {
|
||||||
|
owner: string;
|
||||||
|
repo: string;
|
||||||
|
tag: string;
|
||||||
|
}): Promise<{ data: Release }> {
|
||||||
|
return this.github.rest.repos.getReleaseByTag(params);
|
||||||
|
}
|
||||||
|
|
||||||
|
createRelease(params: {
|
||||||
|
owner: string;
|
||||||
|
repo: string;
|
||||||
|
tag_name: string;
|
||||||
|
name: string;
|
||||||
|
body: string | undefined;
|
||||||
|
draft: boolean | undefined;
|
||||||
|
prerelease: boolean | undefined;
|
||||||
|
target_commitish: string | undefined;
|
||||||
|
discussion_category_name: string | undefined;
|
||||||
|
generate_release_notes: boolean | undefined;
|
||||||
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
|
}): 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);
|
||||||
|
}
|
||||||
|
|
||||||
|
updateRelease(params: {
|
||||||
|
owner: string;
|
||||||
|
repo: string;
|
||||||
|
release_id: number;
|
||||||
|
tag_name: string;
|
||||||
|
target_commitish: string;
|
||||||
|
name: string;
|
||||||
|
body: string | undefined;
|
||||||
|
draft: boolean | undefined;
|
||||||
|
prerelease: boolean | undefined;
|
||||||
|
discussion_category_name: string | undefined;
|
||||||
|
generate_release_notes: boolean | undefined;
|
||||||
|
make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
|
}): 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);
|
||||||
|
}
|
||||||
|
|
||||||
|
allReleases(params: {
|
||||||
|
owner: string;
|
||||||
|
repo: string;
|
||||||
|
}): AsyncIterableIterator<{ data: Release[] }> {
|
||||||
|
const updatedParams = { per_page: 100, ...params };
|
||||||
|
return this.github.paginate.iterator(
|
||||||
|
this.github.rest.repos.listReleases.endpoint.merge(updatedParams),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const asset = (path: string): ReleaseAsset => {
|
||||||
|
return {
|
||||||
|
name: basename(path),
|
||||||
|
mime: mimeOrDefault(path),
|
||||||
|
size: statSync(path).size,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export const mimeOrDefault = (path: string): string => {
|
||||||
|
return getType(path) || "application/octet-stream";
|
||||||
|
};
|
||||||
|
|
||||||
|
export const upload = async (
|
||||||
|
config: Config,
|
||||||
|
github: GitHub,
|
||||||
|
url: string,
|
||||||
|
path: string,
|
||||||
|
currentAssets: Array<{ id: number; name: string }>,
|
||||||
|
): Promise<any> => {
|
||||||
|
const [owner, repo] = config.github_repository.split("/");
|
||||||
|
const { name, mime, size } = asset(path);
|
||||||
|
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.
|
||||||
|
// 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
|
||||||
|
({ name: currentName }) => currentName == alignAssetName(name),
|
||||||
|
);
|
||||||
|
if (currentAsset) {
|
||||||
|
console.log(`♻️ Deleting previously uploaded asset ${name}...`);
|
||||||
|
await github.rest.repos.deleteReleaseAsset({
|
||||||
|
asset_id: currentAsset.id || 1,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
console.log(`⬆️ Uploading ${name}...`);
|
||||||
|
const endpoint = new URL(url);
|
||||||
|
endpoint.searchParams.append("name", name);
|
||||||
|
const fh = await open(path);
|
||||||
|
try {
|
||||||
|
const resp = await github.request({
|
||||||
|
method: "POST",
|
||||||
|
url: endpoint.toString(),
|
||||||
|
headers: {
|
||||||
|
"content-length": `${size}`,
|
||||||
|
"content-type": mime,
|
||||||
|
authorization: `token ${config.github_token}`,
|
||||||
|
},
|
||||||
|
data: fh.readableWebStream({ type: "bytes" }),
|
||||||
|
});
|
||||||
|
const json = resp.data;
|
||||||
|
if (resp.status !== 201) {
|
||||||
|
throw new Error(
|
||||||
|
`Failed to upload release asset ${name}. received status code ${
|
||||||
|
resp.status
|
||||||
|
}\n${json.message}\n${JSON.stringify(json.errors)}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
console.log(`✅ Uploaded ${name}`);
|
||||||
|
return json;
|
||||||
|
} finally {
|
||||||
|
await fh.close();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export const release = async (
|
||||||
|
config: Config,
|
||||||
|
releaser: Releaser,
|
||||||
|
maxRetries: number = 3,
|
||||||
|
): Promise<Release> => {
|
||||||
|
if (maxRetries <= 0) {
|
||||||
|
console.log(`❌ Too many retries. Aborting...`);
|
||||||
|
throw new Error("Too many retries.");
|
||||||
|
}
|
||||||
|
|
||||||
|
const [owner, repo] = config.github_repository.split("/");
|
||||||
|
const tag =
|
||||||
|
config.input_tag_name ||
|
||||||
|
(isTag(config.github_ref)
|
||||||
|
? config.github_ref.replace("refs/tags/", "")
|
||||||
|
: "");
|
||||||
|
|
||||||
|
const discussion_category_name = config.input_discussion_category_name;
|
||||||
|
const generate_release_notes = config.input_generate_release_notes;
|
||||||
|
try {
|
||||||
|
// you can't get an existing draft by tag
|
||||||
|
// so we must find one in the list of all releases
|
||||||
|
let _release: Release | undefined = undefined;
|
||||||
|
for await (const response of releaser.allReleases({
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
})) {
|
||||||
|
_release = response.data.find((release) => release.tag_name === tag);
|
||||||
|
if (_release !== undefined) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (_release === undefined) {
|
||||||
|
return await createRelease(
|
||||||
|
tag,
|
||||||
|
config,
|
||||||
|
releaser,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
discussion_category_name,
|
||||||
|
generate_release_notes,
|
||||||
|
maxRetries,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
let existingRelease: Release = _release!;
|
||||||
|
console.log(
|
||||||
|
`Found release ${existingRelease.name} (with id=${existingRelease.id})`,
|
||||||
|
);
|
||||||
|
|
||||||
|
const release_id = existingRelease.id;
|
||||||
|
let target_commitish: string;
|
||||||
|
if (
|
||||||
|
config.input_target_commitish &&
|
||||||
|
config.input_target_commitish !== existingRelease.target_commitish
|
||||||
|
) {
|
||||||
|
console.log(
|
||||||
|
`Updating commit from "${existingRelease.target_commitish}" to "${config.input_target_commitish}"`,
|
||||||
|
);
|
||||||
|
target_commitish = config.input_target_commitish;
|
||||||
|
} else {
|
||||||
|
target_commitish = existingRelease.target_commitish;
|
||||||
|
}
|
||||||
|
|
||||||
|
const tag_name = tag;
|
||||||
|
const name = config.input_name || existingRelease.name || tag;
|
||||||
|
// revisit: support a new body-concat-strategy input for accumulating
|
||||||
|
// 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
|
||||||
|
// no one wants
|
||||||
|
const workflowBody = releaseBody(config) || "";
|
||||||
|
const existingReleaseBody = existingRelease.body || "";
|
||||||
|
let body: string;
|
||||||
|
if (config.input_append_body && workflowBody && existingReleaseBody) {
|
||||||
|
body = existingReleaseBody + "\n" + workflowBody;
|
||||||
|
} else {
|
||||||
|
body = workflowBody || existingReleaseBody;
|
||||||
|
}
|
||||||
|
|
||||||
|
const draft =
|
||||||
|
config.input_draft !== undefined
|
||||||
|
? config.input_draft
|
||||||
|
: existingRelease.draft;
|
||||||
|
const prerelease =
|
||||||
|
config.input_prerelease !== undefined
|
||||||
|
? config.input_prerelease
|
||||||
|
: existingRelease.prerelease;
|
||||||
|
|
||||||
|
const make_latest = config.input_make_latest;
|
||||||
|
|
||||||
|
const release = await releaser.updateRelease({
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
release_id,
|
||||||
|
tag_name,
|
||||||
|
target_commitish,
|
||||||
|
name,
|
||||||
|
body,
|
||||||
|
draft,
|
||||||
|
prerelease,
|
||||||
|
discussion_category_name,
|
||||||
|
generate_release_notes,
|
||||||
|
make_latest,
|
||||||
|
});
|
||||||
|
return release.data;
|
||||||
|
} catch (error) {
|
||||||
|
if (error.status !== 404) {
|
||||||
|
console.log(
|
||||||
|
`⚠️ Unexpected error fetching GitHub release for tag ${config.github_ref}: ${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 name = config.input_name || tag;
|
||||||
|
const body = releaseBody(config);
|
||||||
|
const draft = config.input_draft;
|
||||||
|
const prerelease = config.input_prerelease;
|
||||||
|
const target_commitish = config.input_target_commitish;
|
||||||
|
const make_latest = config.input_make_latest;
|
||||||
|
let commitMessage: string = "";
|
||||||
|
if (target_commitish) {
|
||||||
|
commitMessage = ` using commit "${target_commitish}"`;
|
||||||
|
}
|
||||||
|
console.log(
|
||||||
|
`👩🏭 Creating new GitHub release for tag ${tag_name}${commitMessage}...`,
|
||||||
|
);
|
||||||
|
try {
|
||||||
|
let release = await releaser.createRelease({
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
tag_name,
|
||||||
|
name,
|
||||||
|
body,
|
||||||
|
draft,
|
||||||
|
prerelease,
|
||||||
|
target_commitish,
|
||||||
|
discussion_category_name,
|
||||||
|
generate_release_notes,
|
||||||
|
make_latest,
|
||||||
|
});
|
||||||
|
return release.data;
|
||||||
|
} catch (error) {
|
||||||
|
// presume a race with competing matrix runs
|
||||||
|
console.log(`⚠️ GitHub release failed with status: ${error.status}`);
|
||||||
|
console.log(`${JSON.stringify(error.response.data)}`);
|
||||||
|
|
||||||
|
switch (error.status) {
|
||||||
|
case 403:
|
||||||
|
console.log(
|
||||||
|
"Skip retry — your GitHub token/PAT does not have the required permission to create a release",
|
||||||
|
);
|
||||||
|
throw error;
|
||||||
|
|
||||||
|
case 404:
|
||||||
|
console.log("Skip retry - discussion category mismatch");
|
||||||
|
throw error;
|
||||||
|
|
||||||
|
case 422:
|
||||||
|
console.log("Skip retry - validation failed");
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`retrying... (${maxRetries - 1} retries remaining)`);
|
||||||
|
return release(config, releaser, maxRetries - 1);
|
||||||
|
}
|
||||||
|
}
|
232
src/main.rs
232
src/main.rs
@ -1,232 +0,0 @@
|
|||||||
mod github;
|
|
||||||
|
|
||||||
use github::{AssetUploader, Release, ReleaseResponse, Releaser};
|
|
||||||
use mime::Mime;
|
|
||||||
use reqwest::Client;
|
|
||||||
use serde::Deserialize;
|
|
||||||
use std::{
|
|
||||||
error::Error,
|
|
||||||
ffi::OsStr,
|
|
||||||
fs::{read_to_string, File},
|
|
||||||
path::{Path, PathBuf},
|
|
||||||
};
|
|
||||||
|
|
||||||
type BoxError = Box<dyn Error>;
|
|
||||||
|
|
||||||
#[derive(Deserialize, Default, Debug, PartialEq, Clone)]
|
|
||||||
struct Config {
|
|
||||||
// github provided
|
|
||||||
github_token: String,
|
|
||||||
github_ref: String,
|
|
||||||
github_repository: String,
|
|
||||||
// user provided
|
|
||||||
input_name: Option<String>,
|
|
||||||
input_body: Option<String>,
|
|
||||||
input_body_path: Option<PathBuf>,
|
|
||||||
input_files: Option<Vec<String>>,
|
|
||||||
input_draft: Option<bool>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Into<Release> for Config {
|
|
||||||
fn into(self) -> Release {
|
|
||||||
let Config {
|
|
||||||
github_ref,
|
|
||||||
input_name,
|
|
||||||
input_body,
|
|
||||||
input_body_path,
|
|
||||||
input_draft,
|
|
||||||
..
|
|
||||||
} = self;
|
|
||||||
let tag_name = github_ref.trim_start_matches("refs/tags/").to_string();
|
|
||||||
let name = input_name.clone().or_else(|| Some(tag_name.clone()));
|
|
||||||
let draft = input_draft;
|
|
||||||
let body = input_body_path
|
|
||||||
.and_then(|path| read_to_string(path).ok())
|
|
||||||
.or_else(|| input_body.clone());
|
|
||||||
Release {
|
|
||||||
tag_name,
|
|
||||||
name,
|
|
||||||
body,
|
|
||||||
draft,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn is_tag<R>(gitref: R) -> bool
|
|
||||||
where
|
|
||||||
R: AsRef<str>,
|
|
||||||
{
|
|
||||||
gitref.as_ref().starts_with("refs/tags/")
|
|
||||||
}
|
|
||||||
|
|
||||||
fn mime_or_default<P>(path: P) -> Mime
|
|
||||||
where
|
|
||||||
P: AsRef<Path>,
|
|
||||||
{
|
|
||||||
mime_guess::from_path(path).first_or(mime::APPLICATION_OCTET_STREAM)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn paths<P>(
|
|
||||||
patterns: impl IntoIterator<Item = P>
|
|
||||||
) -> Result<impl IntoIterator<Item = PathBuf>, BoxError>
|
|
||||||
where
|
|
||||||
P: AsRef<str>,
|
|
||||||
{
|
|
||||||
patterns
|
|
||||||
.into_iter()
|
|
||||||
.try_fold(Vec::new(), |mut paths, pattern| {
|
|
||||||
let matched = glob::glob(pattern.as_ref())?
|
|
||||||
.filter_map(Result::ok)
|
|
||||||
.filter(|p| p.is_file());
|
|
||||||
paths.extend(matched);
|
|
||||||
Ok(paths)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
fn run(
|
|
||||||
conf: Config,
|
|
||||||
releaser: &dyn Releaser,
|
|
||||||
uploader: &dyn AssetUploader,
|
|
||||||
) -> Result<(), BoxError> {
|
|
||||||
if !is_tag(&conf.github_ref) {
|
|
||||||
eprintln!("⚠️ GitHub Releases requires a tag");
|
|
||||||
return Ok(());
|
|
||||||
}
|
|
||||||
|
|
||||||
let ReleaseResponse { id, html_url } = releaser.release(
|
|
||||||
conf.github_token.as_str(),
|
|
||||||
conf.github_repository.as_str(),
|
|
||||||
conf.clone().into(),
|
|
||||||
)?;
|
|
||||||
|
|
||||||
if let Some(patterns) = conf.input_files {
|
|
||||||
for path in paths(patterns)? {
|
|
||||||
let name = &path
|
|
||||||
.file_name()
|
|
||||||
.and_then(OsStr::to_str)
|
|
||||||
.unwrap_or_else(|| "UnknownFile");
|
|
||||||
println!("⬆️ Uploading {}...", name);
|
|
||||||
let status = uploader.upload(
|
|
||||||
conf.github_token.as_str(),
|
|
||||||
conf.github_repository.as_str(),
|
|
||||||
id,
|
|
||||||
name,
|
|
||||||
mime_or_default(&path),
|
|
||||||
File::open(&path)?,
|
|
||||||
)?;
|
|
||||||
if !status.is_success() {
|
|
||||||
println!("⚠️ Failed uploading {} with error {}", name, status);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
println!("🎉 Release ready at {}", html_url);
|
|
||||||
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn main() -> Result<(), BoxError> {
|
|
||||||
env_logger::init();
|
|
||||||
let client = Client::new();
|
|
||||||
run(envy::from_env()?, &client, &client)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::*;
|
|
||||||
#[test]
|
|
||||||
fn mime_or_default_defaults_to_octect_stream() {
|
|
||||||
assert_eq!(
|
|
||||||
mime_or_default("umbiguous-file"),
|
|
||||||
mime::APPLICATION_OCTET_STREAM
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn release_constructs_a_release_from_a_config() -> Result<(), BoxError> {
|
|
||||||
for (conf, expect) in vec![
|
|
||||||
(
|
|
||||||
Config {
|
|
||||||
github_ref: "refs/tags/v1.0.0".into(),
|
|
||||||
..Config::default()
|
|
||||||
},
|
|
||||||
Release {
|
|
||||||
tag_name: "v1.0.0".into(),
|
|
||||||
name: Some("v1.0.0".into()),
|
|
||||||
..Release::default()
|
|
||||||
},
|
|
||||||
),
|
|
||||||
(
|
|
||||||
Config {
|
|
||||||
github_ref: "refs/tags/v1.0.0".into(),
|
|
||||||
input_name: Some("custom".into()),
|
|
||||||
..Config::default()
|
|
||||||
},
|
|
||||||
Release {
|
|
||||||
tag_name: "v1.0.0".into(),
|
|
||||||
name: Some("custom".into()),
|
|
||||||
..Release::default()
|
|
||||||
},
|
|
||||||
),
|
|
||||||
(
|
|
||||||
Config {
|
|
||||||
github_ref: "refs/tags/v1.0.0".into(),
|
|
||||||
input_body: Some("fallback".into()),
|
|
||||||
input_body_path: Some("tests/data/foo/bar.txt".into()),
|
|
||||||
..Config::default()
|
|
||||||
},
|
|
||||||
Release {
|
|
||||||
tag_name: "v1.0.0".into(),
|
|
||||||
name: Some("v1.0.0".into()),
|
|
||||||
body: Some("release me".into()),
|
|
||||||
..Release::default()
|
|
||||||
},
|
|
||||||
),
|
|
||||||
] {
|
|
||||||
assert_eq!(expect, conf.into());
|
|
||||||
}
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn is_tag_checks_refs() {
|
|
||||||
for (gitref, expect) in &[("refs/tags/foo", true), ("refs/heads/master", false)] {
|
|
||||||
assert_eq!(is_tag(gitref), *expect)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn paths_resolves_pattern_to_file_paths() -> Result<(), BoxError> {
|
|
||||||
assert_eq!(paths(vec!["tests/data/**/*"])?.into_iter().count(), 1);
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn config_is_parsed_from_env() -> Result<(), BoxError> {
|
|
||||||
for (env, expect) in vec![(
|
|
||||||
vec![
|
|
||||||
("GITHUB_TOKEN".into(), "123".into()),
|
|
||||||
("GITHUB_REF".into(), "refs/tags/v1.0.0".into()),
|
|
||||||
("GITHUB_REPOSITORY".into(), "foo/bar".into()),
|
|
||||||
("INPUT_NAME".into(), "test release".into()),
|
|
||||||
("INPUT_BODY".into(), ":)".into()),
|
|
||||||
("INPUT_FILES".into(), "*.md".into()),
|
|
||||||
("INPUT_DRAFT".into(), "true".into()),
|
|
||||||
("INPUT_BODY_PATH".into(), "tests/data/foo/bar.txt".into()),
|
|
||||||
],
|
|
||||||
Config {
|
|
||||||
github_token: "123".into(),
|
|
||||||
github_ref: "refs/tags/v1.0.0".into(),
|
|
||||||
github_repository: "foo/bar".into(),
|
|
||||||
input_name: Some("test release".into()),
|
|
||||||
input_body: Some(":)".into()),
|
|
||||||
input_body_path: Some("tests/data/foo/bar.txt".into()),
|
|
||||||
input_files: Some(vec!["*.md".into()]),
|
|
||||||
input_draft: Some(true),
|
|
||||||
},
|
|
||||||
)] {
|
|
||||||
assert_eq!(expect, envy::from_iter::<_, Config>(env)?)
|
|
||||||
}
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
}
|
|
113
src/main.ts
Normal file
113
src/main.ts
Normal file
@ -0,0 +1,113 @@
|
|||||||
|
import {
|
||||||
|
paths,
|
||||||
|
parseConfig,
|
||||||
|
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";
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
try {
|
||||||
|
const config = parseConfig(env);
|
||||||
|
if (
|
||||||
|
!config.input_tag_name &&
|
||||||
|
!isTag(config.github_ref) &&
|
||||||
|
!config.input_draft
|
||||||
|
) {
|
||||||
|
throw new Error(`⚠️ GitHub Releases requires a tag`);
|
||||||
|
}
|
||||||
|
if (config.input_files) {
|
||||||
|
const patterns = unmatchedPatterns(config.input_files);
|
||||||
|
patterns.forEach((pattern) => {
|
||||||
|
if (config.input_fail_on_unmatched_files) {
|
||||||
|
throw new Error(`⚠️ Pattern '${pattern}' does not match any files.`);
|
||||||
|
} else {
|
||||||
|
console.warn(`🤔 Pattern '${pattern}' does not match any files.`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
if (patterns.length > 0 && config.input_fail_on_unmatched_files) {
|
||||||
|
throw new Error(`⚠️ There were unmatched files`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// const oktokit = GitHub.plugin(
|
||||||
|
// require("@octokit/plugin-throttling"),
|
||||||
|
// require("@octokit/plugin-retry")
|
||||||
|
// );
|
||||||
|
|
||||||
|
const gh = getOctokit(config.github_token, {
|
||||||
|
//new oktokit(
|
||||||
|
throttle: {
|
||||||
|
onRateLimit: (retryAfter, options) => {
|
||||||
|
console.warn(
|
||||||
|
`Request quota exhausted for request ${options.method} ${options.url}`,
|
||||||
|
);
|
||||||
|
if (options.request.retryCount === 0) {
|
||||||
|
// only retries once
|
||||||
|
console.log(`Retrying after ${retryAfter} seconds!`);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
onAbuseLimit: (retryAfter, options) => {
|
||||||
|
// does not retry, only logs a warning
|
||||||
|
console.warn(
|
||||||
|
`Abuse detected for request ${options.method} ${options.url}`,
|
||||||
|
);
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
//);
|
||||||
|
const rel = await release(config, new GitHubReleaser(gh));
|
||||||
|
if (config.input_files && config.input_files.length > 0) {
|
||||||
|
const files = paths(config.input_files);
|
||||||
|
if (files.length == 0) {
|
||||||
|
if (config.input_fail_on_unmatched_files) {
|
||||||
|
throw new Error(
|
||||||
|
`⚠️ ${config.input_files} does not include a valid file.`,
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
console.warn(
|
||||||
|
`🤔 ${config.input_files} does not include a valid file.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const currentAssets = rel.assets;
|
||||||
|
|
||||||
|
const uploadFile = async (path) => {
|
||||||
|
const json = await upload(
|
||||||
|
config,
|
||||||
|
gh,
|
||||||
|
uploadUrl(rel.upload_url),
|
||||||
|
path,
|
||||||
|
currentAssets,
|
||||||
|
);
|
||||||
|
delete json.uploader;
|
||||||
|
return json;
|
||||||
|
};
|
||||||
|
|
||||||
|
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);
|
||||||
|
}
|
||||||
|
console.log(`🎉 Release ready at ${rel.html_url}`);
|
||||||
|
setOutput("url", rel.html_url);
|
||||||
|
setOutput("id", rel.id.toString());
|
||||||
|
setOutput("upload_url", rel.upload_url);
|
||||||
|
} catch (error) {
|
||||||
|
setFailed(error.message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
115
src/util.ts
Normal file
115
src/util.ts
Normal file
@ -0,0 +1,115 @@
|
|||||||
|
import * as glob from "glob";
|
||||||
|
import { statSync, readFileSync } from "fs";
|
||||||
|
|
||||||
|
export interface Config {
|
||||||
|
github_token: string;
|
||||||
|
github_ref: string;
|
||||||
|
github_repository: string;
|
||||||
|
// user provided
|
||||||
|
input_name?: string;
|
||||||
|
input_tag_name?: string;
|
||||||
|
input_repository?: string;
|
||||||
|
input_body?: string;
|
||||||
|
input_body_path?: string;
|
||||||
|
input_files?: string[];
|
||||||
|
input_draft?: boolean;
|
||||||
|
input_preserve_order?: boolean;
|
||||||
|
input_prerelease?: boolean;
|
||||||
|
input_fail_on_unmatched_files?: boolean;
|
||||||
|
input_target_commitish?: string;
|
||||||
|
input_discussion_category_name?: string;
|
||||||
|
input_generate_release_notes?: boolean;
|
||||||
|
input_append_body?: boolean;
|
||||||
|
input_make_latest: "true" | "false" | "legacy" | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const uploadUrl = (url: string): string => {
|
||||||
|
const templateMarkerPos = url.indexOf("{");
|
||||||
|
if (templateMarkerPos > -1) {
|
||||||
|
return url.substring(0, templateMarkerPos);
|
||||||
|
}
|
||||||
|
return url;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const releaseBody = (config: Config): string | undefined => {
|
||||||
|
return (
|
||||||
|
(config.input_body_path &&
|
||||||
|
readFileSync(config.input_body_path).toString("utf8")) ||
|
||||||
|
config.input_body
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
type Env = { [key: string]: string | undefined };
|
||||||
|
|
||||||
|
export const parseInputFiles = (files: string): string[] => {
|
||||||
|
return files.split(/\r?\n/).reduce<string[]>(
|
||||||
|
(acc, line) =>
|
||||||
|
acc
|
||||||
|
.concat(line.split(","))
|
||||||
|
.filter((pat) => pat)
|
||||||
|
.map((pat) => pat.trim()),
|
||||||
|
[],
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const parseConfig = (env: Env): Config => {
|
||||||
|
return {
|
||||||
|
github_token: env.GITHUB_TOKEN || env.INPUT_TOKEN || "",
|
||||||
|
github_ref: env.GITHUB_REF || "",
|
||||||
|
github_repository: env.INPUT_REPOSITORY || env.GITHUB_REPOSITORY || "",
|
||||||
|
input_name: env.INPUT_NAME,
|
||||||
|
input_tag_name: env.INPUT_TAG_NAME?.trim(),
|
||||||
|
input_body: env.INPUT_BODY,
|
||||||
|
input_body_path: env.INPUT_BODY_PATH,
|
||||||
|
input_files: parseInputFiles(env.INPUT_FILES || ""),
|
||||||
|
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
|
||||||
|
? env.INPUT_PRERELEASE == "true"
|
||||||
|
: undefined,
|
||||||
|
input_fail_on_unmatched_files: env.INPUT_FAIL_ON_UNMATCHED_FILES == "true",
|
||||||
|
input_target_commitish: env.INPUT_TARGET_COMMITISH || undefined,
|
||||||
|
input_discussion_category_name:
|
||||||
|
env.INPUT_DISCUSSION_CATEGORY_NAME || undefined,
|
||||||
|
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),
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
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[] => {
|
||||||
|
return patterns.reduce((acc: string[], pattern: string): string[] => {
|
||||||
|
return acc.concat(
|
||||||
|
glob.sync(pattern).filter((path) => statSync(path).isFile()),
|
||||||
|
);
|
||||||
|
}, []);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const unmatchedPatterns = (patterns: string[]): string[] => {
|
||||||
|
return patterns.reduce((acc: string[], pattern: string): string[] => {
|
||||||
|
return acc.concat(
|
||||||
|
glob.sync(pattern).filter((path) => statSync(path).isFile()).length == 0
|
||||||
|
? [pattern]
|
||||||
|
: [],
|
||||||
|
);
|
||||||
|
}, []);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const isTag = (ref: string): boolean => {
|
||||||
|
return ref.startsWith("refs/tags/");
|
||||||
|
};
|
||||||
|
|
||||||
|
export const alignAssetName = (assetName: string): string => {
|
||||||
|
return assetName.replace(/ /g, ".");
|
||||||
|
};
|
64
tsconfig.json
Normal file
64
tsconfig.json
Normal file
@ -0,0 +1,64 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"useUnknownInCatchVariables": false,
|
||||||
|
/* Basic Options */
|
||||||
|
// "incremental": true, /* Enable incremental compilation */
|
||||||
|
"target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
|
||||||
|
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
|
||||||
|
// "allowJs": true, /* Allow javascript files to be compiled. */
|
||||||
|
// "checkJs": true, /* Report errors in .js files. */
|
||||||
|
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
|
||||||
|
// "declaration": true, /* Generates corresponding '.d.ts' file. */
|
||||||
|
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
|
||||||
|
// "sourceMap": true, /* Generates corresponding '.map' file. */
|
||||||
|
// "outFile": "./", /* Concatenate and emit output to single file. */
|
||||||
|
"outDir": "./lib", /* Redirect output structure to the directory. */
|
||||||
|
"rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
|
||||||
|
// "composite": true, /* Enable project compilation */
|
||||||
|
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
|
||||||
|
// "removeComments": true, /* Do not emit comments to output. */
|
||||||
|
// "noEmit": true, /* Do not emit outputs. */
|
||||||
|
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
|
||||||
|
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
|
||||||
|
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
|
||||||
|
|
||||||
|
/* Strict Type-Checking Options */
|
||||||
|
"strict": true, /* Enable all strict type-checking options. */
|
||||||
|
"noImplicitAny": false, /* Raise error on expressions and declarations with an implied 'any' type. */
|
||||||
|
// "strictNullChecks": true, /* Enable strict null checks. */
|
||||||
|
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
|
||||||
|
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
|
||||||
|
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
|
||||||
|
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
|
||||||
|
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
|
||||||
|
|
||||||
|
/* Additional Checks */
|
||||||
|
// "noUnusedLocals": true, /* Report errors on unused locals. */
|
||||||
|
// "noUnusedParameters": true, /* Report errors on unused parameters. */
|
||||||
|
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
|
||||||
|
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
|
||||||
|
|
||||||
|
/* Module Resolution Options */
|
||||||
|
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
|
||||||
|
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
|
||||||
|
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
|
||||||
|
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
|
||||||
|
// "typeRoots": [], /* List of folders to include type definitions from. */
|
||||||
|
// "types": [], /* Type declaration files to be included in compilation. */
|
||||||
|
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
|
||||||
|
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
|
||||||
|
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
|
||||||
|
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
||||||
|
|
||||||
|
/* Source Map Options */
|
||||||
|
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
|
||||||
|
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
||||||
|
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
|
||||||
|
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
|
||||||
|
|
||||||
|
/* Experimental Options */
|
||||||
|
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
|
||||||
|
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
|
||||||
|
},
|
||||||
|
"exclude": ["node_modules", "**/*.test.ts", "jest.config.ts"]
|
||||||
|
}
|
Loading…
x
Reference in New Issue
Block a user