Compare commits
142 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
84f3aed823 | ||
|
f9770cdf31 | ||
|
1b2bf5c959 | ||
|
265508bc9f | ||
|
04733e069f | ||
|
7b5b755e5b | ||
|
17449a21ea | ||
|
ec2ff03a5a | ||
|
ff23fb2574 | ||
|
8e438350b0 | ||
|
fe68892921 | ||
|
a13e7b5d40 | ||
|
a4bae284e7 | ||
|
c19ddf4c20 | ||
|
2d9c0f4337 | ||
|
615015f76e | ||
|
e3374ce5b6 | ||
|
1beeb572c1 | ||
|
5206d34958 | ||
|
80d7a7e41c | ||
|
5eb2ffd70b | ||
|
07af2f374a | ||
|
5164410c7d | ||
|
f47fb36ff1 | ||
|
212d4babf8 | ||
|
7670b98fa0 | ||
|
ac438791c4 | ||
|
545e4c402b | ||
|
7d304ee154 | ||
|
3cff01dd32 | ||
|
a724093295 | ||
|
2b9d2847a9 | ||
|
f9beb0ad08 | ||
|
1662cfa449 | ||
|
a5002416a0 | ||
|
58d5258088 | ||
|
ffc1afa9c0 | ||
|
24bced81d9 | ||
|
794b3152e1 | ||
|
b00963776a | ||
|
210500d479 | ||
|
f0dfba8919 | ||
|
42c63808d6 | ||
|
febd7d0808 | ||
|
d8e2a64134 | ||
|
a4af572b12 | ||
|
7d4e20c14b | ||
|
7e467024cd | ||
|
e225e77501 | ||
|
6295ff030e | ||
|
37a32b0167 | ||
|
0c6fec2cea | ||
|
37f4f3a9cd | ||
|
dfae8c036c | ||
|
99e2100a1f | ||
|
664a7c20c1 | ||
|
760a5584dc | ||
|
580065490f | ||
|
eed453b613 | ||
|
7319e4733e | ||
|
4e86b8565b | ||
|
3a6baf0f12 | ||
|
e8c797e08e | ||
|
cf83be2c7f | ||
|
cfdd9b50bd | ||
|
cc92c9093e | ||
|
72f6bf584a | ||
|
f2899b4677 | ||
|
af306bddfe | ||
|
9927d3f5ec | ||
|
e5e4b800aa | ||
|
74f6bde645 | ||
|
0e6c75888a | ||
|
5cbce4f5ee | ||
|
df11ebfac2 | ||
|
50a5b0990c | ||
|
0e0bd99213 | ||
|
8250434419 | ||
|
9093186278 | ||
|
321f000b6d | ||
|
233ab9a35e | ||
|
d3a6c14a79 | ||
|
fa5d5d5a33 | ||
|
442eb645ce | ||
|
4d1e10f6d1 | ||
|
f63a22975a | ||
|
a9842f0f62 | ||
|
2728235f7d | ||
|
c2e0608dc4 | ||
|
bd74772a1a | ||
|
16e7903b2d | ||
|
f2c549b117 | ||
|
7a7d004438 | ||
|
9c4a92ec0d | ||
|
039214a996 | ||
|
2b373356cb | ||
|
1819382cf9 | ||
|
fb1eb39e74 | ||
|
7786b24bd8 | ||
|
133984371c | ||
|
c2b649c57e | ||
|
eb625cd0ad | ||
|
99cbd251b2 | ||
|
a6824c9e54 | ||
|
6eb74c809d | ||
|
8ec375d911 | ||
|
8d45355ac2 | ||
|
7d269bd712 | ||
|
c71fb95114 | ||
|
1d71c233f7 | ||
|
78ec101a88 | ||
|
d8cafc3c87 | ||
|
a70d06e688 | ||
|
072f986a7c | ||
|
2f88c7710e | ||
|
ee200cfabc | ||
|
82b6f4a2ea | ||
|
3f585610ac | ||
|
61a0748878 | ||
|
743e8a90bd | ||
|
15ebdecb60 | ||
|
57649ec774 | ||
|
f9dffdf5a6 | ||
|
71756ac6ec | ||
|
2b6c678b07 | ||
|
a95c4e7c33 | ||
|
4e5de20777 | ||
|
3f38d56a41 | ||
|
483c1e56f9 | ||
|
1899a6bd0d | ||
|
bf76499b98 | ||
|
e74ff71f7d | ||
|
697a9f190e | ||
|
011f7957ff | ||
|
4f71b6d30b | ||
|
24b1cacbb1 | ||
|
4ce0a13e83 | ||
|
6ca3eb1422 | ||
|
54a6699008 | ||
|
afb12c9a16 | ||
|
89767936cf | ||
|
d3d2e8da76 |
@ -24,7 +24,7 @@
|
||||
"@typescript-eslint/func-call-spacing": ["error", "never"],
|
||||
"@typescript-eslint/no-array-constructor": "error",
|
||||
"@typescript-eslint/no-empty-interface": "error",
|
||||
"@typescript-eslint/no-explicit-any": "error",
|
||||
"@typescript-eslint/no-explicit-any": "off",
|
||||
"@typescript-eslint/no-extraneous-class": "error",
|
||||
"@typescript-eslint/no-for-in-array": "error",
|
||||
"@typescript-eslint/no-inferrable-types": "error",
|
||||
|
47
.github/workflows/ci.yml
vendored
47
.github/workflows/ci.yml
vendored
@ -9,7 +9,7 @@ jobs:
|
||||
matrix:
|
||||
os: [ubuntu-latest, windows-latest, macos-latest]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
- run: |
|
||||
npm install
|
||||
npm run all
|
||||
@ -21,7 +21,7 @@ jobs:
|
||||
matrix:
|
||||
os: [ubuntu-latest, windows-latest, macos-latest]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
- name: Make test pre-release
|
||||
uses: ./
|
||||
with:
|
||||
@ -31,26 +31,57 @@ jobs:
|
||||
tag: ci-test-${{ matrix.os }}-${{ github.run_id }}
|
||||
overwrite: true
|
||||
prerelease: true
|
||||
body: "rofl lol test"
|
||||
make_latest: true
|
||||
body: "rofl lol test%0Aianal %25 fubar"
|
||||
- name: Check that the uploaded asset is readable
|
||||
uses: actions/github-script@v2
|
||||
with:
|
||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
script: |
|
||||
const fs = require('fs')
|
||||
const child_process = require('child_process');
|
||||
const assert = require('assert').strict;
|
||||
|
||||
const expected = fs.readFileSync("README.md")
|
||||
const expected = fs.readFileSync("README.md", "utf-8")
|
||||
const release = await github.repos.getReleaseByTag({
|
||||
...context.repo,
|
||||
tag: "ci-test-${{ matrix.os }}-${{ github.run_id }}",
|
||||
})
|
||||
assert.deepStrictEqual(release.data.prerelease, true)
|
||||
assert.deepStrictEqual(release.data.body, "rofl lol test")
|
||||
assert.deepStrictEqual(release.data.body, "rofl lol test\nianal % fubar")
|
||||
assert.deepStrictEqual(release.data.assets[0].name, "TEST.md")
|
||||
const actual = child_process.execSync(`curl -Ls ${release.data.assets[0].browser_download_url}`)
|
||||
assert.deepStrictEqual(expected, actual)
|
||||
const actual = await github.request(release.data.assets[0].browser_download_url)
|
||||
assert.deepStrictEqual(expected, actual.data)
|
||||
- name: Make test promote
|
||||
uses: ./
|
||||
with:
|
||||
repo_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
file: README.md
|
||||
asset_name: TEST.md
|
||||
tag: ci-test-${{ matrix.os }}-${{ github.run_id }}
|
||||
overwrite: true
|
||||
promote: true
|
||||
prerelease: false
|
||||
make_latest: true
|
||||
body: "new body"
|
||||
- name: Check that the release is promoted
|
||||
uses: actions/github-script@v2
|
||||
with:
|
||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
retries: 15
|
||||
script: |
|
||||
const fs = require('fs')
|
||||
const assert = require('assert').strict;
|
||||
|
||||
const expected = fs.readFileSync("README.md", "utf-8")
|
||||
const release = await github.repos.getReleaseByTag({
|
||||
...context.repo,
|
||||
tag: "ci-test-${{ matrix.os }}-${{ github.run_id }}",
|
||||
})
|
||||
assert.deepStrictEqual(release.data.prerelease, false)
|
||||
assert.deepStrictEqual(release.data.body, "new body")
|
||||
assert.deepStrictEqual(release.data.assets[0].name, "TEST.md")
|
||||
const actual = await github.request(release.data.assets[0].browser_download_url)
|
||||
assert.deepStrictEqual(expected, actual.data)
|
||||
- name: Clean up
|
||||
if: ${{ always() }}
|
||||
uses: actions/github-script@v2
|
||||
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -2,3 +2,4 @@ node_modules
|
||||
run.sh
|
||||
__tests__/runner/*
|
||||
lib/**/*
|
||||
.idea
|
||||
|
43
CHANGELOG.md
43
CHANGELOG.md
@ -1,5 +1,48 @@
|
||||
# Changelog
|
||||
|
||||
## [2.9.0] - 2024-02-22
|
||||
- Allow seeting a release as draft [#112](https://github.com/svenstaro/upload-release-action/pull/112) (thanks @ShonP40)
|
||||
|
||||
## [2.8.0] - 2024-02-21
|
||||
- Bump all deps
|
||||
- Update to node 20
|
||||
|
||||
## [2.7.0] - 2023-07-28
|
||||
- Allow setting an explicit target_commitish [#46](https://github.com/svenstaro/upload-release-action/pull/46) (thanks @Spikatrix)
|
||||
|
||||
## [2.6.1] - 2023-05-31
|
||||
- Do not overwrite body or name if empty [#108](https://github.com/svenstaro/upload-release-action/pull/108) (thanks @regevbr)
|
||||
|
||||
## [2.6.0] - 2023-05-23
|
||||
- Add `make_latest` input parameter. Can be set to `false` to prevent the created release from being marked as the latest release for the repository [#100](https://github.com/svenstaro/upload-release-action/pull/100) (thanks @brandonkelly)
|
||||
- Don't try to upload empty files [#102](https://github.com/svenstaro/upload-release-action/pull/102) (thanks @Loyalsoldier)
|
||||
- Bump all deps [#105](https://github.com/svenstaro/upload-release-action/pull/105)
|
||||
- `overwrite` option also overwrites name and body [#106](https://github.com/svenstaro/upload-release-action/pull/106) (thanks @regevbr)
|
||||
- Add `promote` option to allow prereleases to be promoted [#74](https://github.com/svenstaro/upload-release-action/pull/74) (thanks @regevbr)
|
||||
|
||||
## [2.5.0] - 2023-02-21
|
||||
- Add retry to upload release [#96](https://github.com/svenstaro/upload-release-action/pull/96) (thanks @sonphantrung)
|
||||
|
||||
## [2.4.1] - 2023-02-01
|
||||
- Modernize octokit usage
|
||||
|
||||
## [2.4.0] - 2023-01-09
|
||||
- Update to node 16
|
||||
- Bump most dependencies
|
||||
|
||||
## [2.3.0] - 2022-06-05
|
||||
- Now defaults `repo_token` to `${{ github.token }}` and `tag` to `${{ github.ref }}` [#69](https://github.com/svenstaro/upload-release-action/pull/69) (thanks @leighmcculloch)
|
||||
|
||||
## [2.2.1] - 2020-12-16
|
||||
- Added support for the GitHub pagination API for repositories with many releases [#36](https://github.com/svenstaro/upload-release-action/pull/36) (thanks @djpohly)
|
||||
|
||||
## [2.2.0] - 2020-10-07
|
||||
- Add support for ceating a new release in a foreign repository [#25](https://github.com/svenstaro/upload-release-action/pull/25) (thanks @kittaakos)
|
||||
- Upgrade all deps
|
||||
|
||||
## [2.1.1] - 2020-09-25
|
||||
- Fix `release_name` option [#27](https://github.com/svenstaro/upload-release-action/pull/27) (thanks @kittaakos)
|
||||
|
||||
## [2.1.0] - 2020-08-10
|
||||
- Strip refs/heads/ from the input tag [#23](https://github.com/svenstaro/upload-release-action/pull/23) (thanks @OmarEmaraDev)
|
||||
|
||||
|
112
README.md
112
README.md
@ -1,4 +1,4 @@
|
||||
# Upload files to a GitHub release [](https://github.com/svenstaro/upload-release-action/actions)
|
||||
# Upload files to a GitHub release [](https://github.com/svenstaro/upload-release-action/actions)
|
||||
|
||||
This action allows you to select which files to upload to the just-tagged release.
|
||||
It runs on all operating systems types offered by GitHub.
|
||||
@ -7,19 +7,24 @@ It runs on all operating systems types offered by GitHub.
|
||||
|
||||
You must provide:
|
||||
|
||||
- `repo_token`: Usually you'll want to set this to `${{ secrets.GITHUB_TOKEN }}`.
|
||||
- `file`: A local file to be uploaded as the asset.
|
||||
- `tag`: The tag to upload into. If you want the current event's tag or branch name, use `${{ github.ref }}` (the `refs/tags/` and `refs/heads/` prefixes will be automatically stripped).
|
||||
|
||||
Optional Arguments
|
||||
|
||||
- `repo_token`: Defaults to `github.token`.
|
||||
- `tag`: The tag to upload into. If you want the current event's tag or branch name, use `${{ github.ref }}` (the `refs/tags/` and `refs/heads/` prefixes will be automatically stripped). Defaults to `github.ref`.
|
||||
- `asset_name`: The name the file gets as an asset on a release. Use `$tag` to include the tag name. When not provided it will default to the filename.
|
||||
This is not used if `file_glob` is set to `true`.
|
||||
- `file_glob`: If set to true, the file argument can be a glob pattern (`asset_name` is ignored in this case) (Default: `false`)
|
||||
- `file_glob`: If set to true, the `file` argument can be a glob pattern (`asset_name` is ignored in this case) (Default: `false`)
|
||||
- `overwrite`: If an asset with the same name already exists, overwrite it (Default: `false`).
|
||||
- `promote`: If a prerelease already exists, promote it to a release (Default: `false`).
|
||||
- `draft`: Sets the release as a draft instead of publishing it, allowing you to make any edits needed before releasing (Default: `false`).
|
||||
- `prerelease`: Mark the release as a pre-release (Default: `false`).
|
||||
- `make_latest`: Mark the release as the latest release for the repository (Default: `true`).
|
||||
- `release_name`: Explicitly set a release name. (Defaults: implicitly same as `tag` via GitHub API).
|
||||
- `body`: Content of the release text (Defaut: `""`).
|
||||
- `target_commit`: Sets the commit hash or branch for the tag to be based on (Default: the default branch, usually `main`).
|
||||
- `body`: Content of the release text (Default: `""`).
|
||||
- `repo_name`: Specify the name of the GitHub repository in which the GitHub release will be created, edited, and deleted. If the repository is other than the current, it is required to create a personal access token with `repo`, `user`, `admin:repo_hook` scopes to the foreign repository and add it as a secret. (Default: current repository).
|
||||
|
||||
## Output variables
|
||||
|
||||
@ -46,7 +51,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
- name: Build
|
||||
run: cargo build --release
|
||||
- name: Upload binaries to release
|
||||
@ -88,7 +93,7 @@ jobs:
|
||||
asset_name: mything-macos-amd64
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
- name: Build
|
||||
run: cargo build --release --locked
|
||||
- name: Upload binaries to release
|
||||
@ -101,18 +106,20 @@ jobs:
|
||||
```
|
||||
|
||||
Example with `file_glob`:
|
||||
|
||||
```yaml
|
||||
name: Publish
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: Publish binaries
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v3
|
||||
- name: Build
|
||||
run: cargo build --release
|
||||
- name: Upload binaries to release
|
||||
@ -125,12 +132,101 @@ jobs:
|
||||
file_glob: true
|
||||
```
|
||||
|
||||
Example for creating a release in a foreign repository using `repo_name`:
|
||||
|
||||
```yaml
|
||||
name: Publish
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: Publish binaries
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: Build
|
||||
run: cargo build --release
|
||||
- name: Upload binaries to release
|
||||
uses: svenstaro/upload-release-action@v2
|
||||
with:
|
||||
repo_name: owner/repository-name
|
||||
# A personal access token for the GitHub repository in which the release will be created and edited.
|
||||
# It is recommended to create the access token with the following scopes: `repo, user, admin:repo_hook`.
|
||||
repo_token: ${{ secrets.YOUR_PERSONAL_ACCESS_TOKEN }}
|
||||
file: target/release/mything
|
||||
asset_name: mything
|
||||
tag: ${{ github.ref }}
|
||||
overwrite: true
|
||||
body: "This is my release text"
|
||||
```
|
||||
|
||||
**Example for feeding a file from repo to the `body` tag:**
|
||||
|
||||
This example covers following points:
|
||||
* Reading a file present on the repo. For example, `release.md` which is placed in root directory of the repo.
|
||||
* Modify & push the `release.md` file before triggering this action (create tag for this example) to dynamically change the body of the release.
|
||||
|
||||
```yaml
|
||||
name: Publish
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
jobs:
|
||||
|
||||
build:
|
||||
name: Publish binaries
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
# This step reads a file from repo and use it for body of the release
|
||||
# This works on any self-hosted runner OS
|
||||
- name: Read release.md and use it as a body of new release
|
||||
id: read_release
|
||||
shell: bash
|
||||
run: |
|
||||
r=$(cat path/to/release.md) # <--- Read release.md (Provide correct path as per your repo)
|
||||
r="${r//'%'/'%25'}" # Multiline escape sequences for %
|
||||
r="${r//$'\n'/'%0A'}" # Multiline escape sequences for '\n'
|
||||
r="${r//$'\r'/'%0D'}" # Multiline escape sequences for '\r'
|
||||
echo "RELEASE_BODY=$r" >> $GITHUB_OUTPUT # <--- Set environment variable
|
||||
|
||||
- name: Upload Binaries to Release
|
||||
uses: svenstaro/upload-release-action@v2
|
||||
with:
|
||||
repo_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
tag: ${{ github.ref }}
|
||||
body: |
|
||||
${{ steps.read_release.outputs.RELEASE_BODY }} # <--- Use environment variables that was created earlier
|
||||
|
||||
```
|
||||
|
||||
### Permissions
|
||||
|
||||
This actions requires writes access to the release. If you are using [granular permissions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions)
|
||||
in your workflow, you will need to add the `contents: write` permission to the token:
|
||||
|
||||
```yaml
|
||||
permissions:
|
||||
contents: write
|
||||
```
|
||||
|
||||
## Releasing
|
||||
|
||||
To release this Action:
|
||||
|
||||
- Bump version in `package.json`
|
||||
- Create `CHANGELOG.md` entry
|
||||
- `npm update`
|
||||
- `npm run all`
|
||||
- `git commit -am <version>`
|
||||
- `git tag -sm <version> <version>`
|
||||
|
14
action.yml
14
action.yml
@ -8,27 +8,39 @@ inputs:
|
||||
repo_token:
|
||||
description: 'GitHub token.'
|
||||
required: true
|
||||
default: ${{ github.token }}
|
||||
file:
|
||||
description: 'Local file to upload.'
|
||||
required: true
|
||||
tag:
|
||||
description: 'Tag to use as a release.'
|
||||
required: true
|
||||
default: ${{ github.ref }}
|
||||
asset_name:
|
||||
description: 'Name of the asset. When not provided will use the file name. Unused if file_glob is set to "true".'
|
||||
overwrite:
|
||||
description: 'Overwrite the release in case it already exists.'
|
||||
promote:
|
||||
description: 'Promote a prerelease to release. Defaults to "false".'
|
||||
file_glob:
|
||||
description: 'If true the file can be a glob pattern, asset_name is ignored if this is true.'
|
||||
draft:
|
||||
description: 'Mark the release as a draft. Defaults to "false".'
|
||||
prerelease:
|
||||
description: 'Mark the release as a pre-release. Defaults to "false".'
|
||||
make_latest:
|
||||
description: 'Mark the release the latest release for the repository. Defaults to "true".'
|
||||
release_name:
|
||||
description: 'Explicitly set a release name. Defaults to empty which will cause the release to take the tag as name on GitHub.'
|
||||
body:
|
||||
description: 'Content of the release text. Empty by default.'
|
||||
target_commit:
|
||||
description: 'Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository\"s default branch (usually `main`).'
|
||||
repo_name:
|
||||
description: 'Specify the name of the GitHub repository in which the GitHub release will be created, edited, and deleted. If the repository is other than the current, it is required to create a personal access token with `repo`, `user`, `admin:repo_hook` scopes to the foreign repository and add it as a secret. Defaults to the current repository'
|
||||
outputs:
|
||||
browser_download_url:
|
||||
description: 'The publicly available URL of the asset.'
|
||||
runs:
|
||||
using: 'node12'
|
||||
using: 'node20'
|
||||
main: 'dist/index.js'
|
||||
|
50246
dist/index.js
vendored
50246
dist/index.js
vendored
File diff suppressed because one or more lines are too long
14177
package-lock.json
generated
14177
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
39
package.json
39
package.json
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "upload-release-action",
|
||||
"version": "2.1.0",
|
||||
"version": "2.9.0",
|
||||
"private": true,
|
||||
"description": "Upload files to a GitHub release",
|
||||
"main": "lib/main.js",
|
||||
@ -27,24 +27,27 @@
|
||||
"author": "Sven-Hendrik Haase",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@actions/core": "^1.2.0",
|
||||
"@actions/github": "^4.0.0",
|
||||
"@types/glob": "^7.1.2",
|
||||
"glob": "^7.1.6"
|
||||
"@actions/core": "^1.10.1",
|
||||
"@actions/github": "^6.0.0",
|
||||
"@lifeomic/attempt": "^3.0.3",
|
||||
"@octokit/core": "^5.1.0",
|
||||
"glob": "^10"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^24.9.1",
|
||||
"@types/node": "^12.12.47",
|
||||
"@typescript-eslint/parser": "^3.5.0",
|
||||
"@zeit/ncc": "^0.22.3",
|
||||
"eslint": "^7.3.1",
|
||||
"eslint-plugin-github": "^4.0.1",
|
||||
"eslint-plugin-jest": "^23.17.1",
|
||||
"jest": "^26.1.0",
|
||||
"jest-circus": "^26.1.0",
|
||||
"js-yaml": "^3.14.0",
|
||||
"prettier": "^2.0.5",
|
||||
"ts-jest": "^26.1.1",
|
||||
"typescript": "^3.9.6"
|
||||
"@octokit/types": "^12.5.0",
|
||||
"@types/jest": "^29",
|
||||
"@types/node": "^20",
|
||||
"@typescript-eslint/eslint-plugin": "^7.0.2",
|
||||
"@typescript-eslint/parser": "^7",
|
||||
"@vercel/ncc": "^0.38.1",
|
||||
"eslint": "^8",
|
||||
"eslint-plugin-github": "^4.10",
|
||||
"eslint-plugin-jest": "^27",
|
||||
"jest": "^29",
|
||||
"jest-circus": "^29",
|
||||
"js-yaml": "^4",
|
||||
"prettier": "^3.2",
|
||||
"ts-jest": "^29",
|
||||
"typescript": "^5"
|
||||
}
|
||||
}
|
||||
|
184
src/main.ts
184
src/main.ts
@ -5,51 +5,120 @@ import * as core from '@actions/core'
|
||||
import * as github from '@actions/github'
|
||||
import * as path from 'path'
|
||||
import * as glob from 'glob'
|
||||
import {retry} from '@lifeomic/attempt'
|
||||
|
||||
type RepoAssetsResp = Endpoints['GET /repos/:owner/:repo/releases/:release_id/assets']['response']
|
||||
type ReleaseByTagResp = Endpoints['GET /repos/:owner/:repo/releases/tags/:tag']['response']
|
||||
type CreateReleaseResp = Endpoints['POST /repos/:owner/:repo/releases']['response']
|
||||
type UploadAssetResp = Endpoints['POST /repos/:owner/:repo/releases/:release_id/assets{?name,label}']['response']
|
||||
const getRef = 'GET /repos/{owner}/{repo}/git/ref/{ref}' as const
|
||||
const releaseByTag = 'GET /repos/{owner}/{repo}/releases/tags/{tag}' as const
|
||||
const createRelease = 'POST /repos/{owner}/{repo}/releases' as const
|
||||
const updateRelease =
|
||||
'PATCH /repos/{owner}/{repo}/releases/{release_id}' as const
|
||||
const repoAssets =
|
||||
'GET /repos/{owner}/{repo}/releases/{release_id}/assets' as const
|
||||
const uploadAssets =
|
||||
'POST {origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}' as const
|
||||
const deleteAssets =
|
||||
'DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}' as const
|
||||
|
||||
type ReleaseByTagResp = Endpoints[typeof releaseByTag]['response']
|
||||
type CreateReleaseResp = Endpoints[typeof createRelease]['response']
|
||||
type RepoAssetsResp = Endpoints[typeof repoAssets]['response']['data']
|
||||
type UploadAssetResp = Endpoints[typeof uploadAssets]['response']
|
||||
type UpdateReleaseResp = Endpoints[typeof updateRelease]['response']
|
||||
type UpdateReleaseParams = Endpoints[typeof updateRelease]['parameters']
|
||||
|
||||
async function get_release_by_tag(
|
||||
tag: string,
|
||||
draft: boolean,
|
||||
prerelease: boolean,
|
||||
make_latest: boolean,
|
||||
release_name: string,
|
||||
body: string,
|
||||
octokit: Octokit
|
||||
): Promise<ReleaseByTagResp | CreateReleaseResp> {
|
||||
octokit: Octokit,
|
||||
overwrite: boolean,
|
||||
promote: boolean,
|
||||
target_commit: string
|
||||
): Promise<ReleaseByTagResp | CreateReleaseResp | UpdateReleaseResp> {
|
||||
let release: ReleaseByTagResp
|
||||
try {
|
||||
core.debug(`Getting release by tag ${tag}.`)
|
||||
return await octokit.repos.getReleaseByTag({
|
||||
...github.context.repo,
|
||||
release = await octokit.request(releaseByTag, {
|
||||
...repo(),
|
||||
tag: tag
|
||||
})
|
||||
} catch (error) {
|
||||
} catch (error: any) {
|
||||
// If this returns 404, we need to create the release first.
|
||||
if (error.status === 404) {
|
||||
core.debug(
|
||||
`Release for tag ${tag} doesn't exist yet so we'll create it now.`
|
||||
)
|
||||
return await octokit.repos.createRelease({
|
||||
...github.context.repo,
|
||||
if (target_commit) {
|
||||
try {
|
||||
await octokit.request(getRef, {
|
||||
...repo(),
|
||||
ref: `tags/${tag}`
|
||||
})
|
||||
core.warning(
|
||||
`Ignoring target_commit as the tag ${tag} already exists`
|
||||
)
|
||||
} catch (tagError: any) {
|
||||
if (tagError.status !== 404) {
|
||||
throw tagError
|
||||
}
|
||||
}
|
||||
}
|
||||
return await octokit.request(createRelease, {
|
||||
...repo(),
|
||||
tag_name: tag,
|
||||
draft: draft,
|
||||
prerelease: prerelease,
|
||||
release_name: release_name,
|
||||
body: body
|
||||
make_latest: make_latest ? 'true' : 'false',
|
||||
name: release_name,
|
||||
body: body,
|
||||
target_commitish: target_commit
|
||||
})
|
||||
} else {
|
||||
throw error
|
||||
}
|
||||
}
|
||||
let updateObject: Partial<UpdateReleaseParams> | undefined
|
||||
if (promote && release.data.prerelease) {
|
||||
core.debug(`The ${tag} is a prerelease, promoting it to a release.`)
|
||||
updateObject = updateObject || {}
|
||||
updateObject.prerelease = false
|
||||
}
|
||||
if (overwrite) {
|
||||
if (release_name && release.data.name !== release_name) {
|
||||
core.debug(
|
||||
`The ${tag} release already exists with a different name ${release.data.name} so we'll overwrite it.`
|
||||
)
|
||||
updateObject = updateObject || {}
|
||||
updateObject.name = release_name
|
||||
}
|
||||
if (body && release.data.body !== body) {
|
||||
core.debug(
|
||||
`The ${tag} release already exists with a different body ${release.data.body} so we'll overwrite it.`
|
||||
)
|
||||
updateObject = updateObject || {}
|
||||
updateObject.body = body
|
||||
}
|
||||
}
|
||||
if (updateObject) {
|
||||
return octokit.request(updateRelease, {
|
||||
...repo(),
|
||||
...updateObject,
|
||||
release_id: release.data.id
|
||||
})
|
||||
}
|
||||
return release
|
||||
}
|
||||
|
||||
async function upload_to_release(
|
||||
release: ReleaseByTagResp | CreateReleaseResp,
|
||||
release: ReleaseByTagResp | CreateReleaseResp | UpdateReleaseResp,
|
||||
file: string,
|
||||
asset_name: string,
|
||||
tag: string,
|
||||
overwrite: boolean,
|
||||
octokit: Octokit
|
||||
octokit: ReturnType<(typeof github)['getOctokit']>
|
||||
): Promise<undefined | string> {
|
||||
const stat = fs.statSync(file)
|
||||
if (!stat.isFile()) {
|
||||
@ -57,21 +126,24 @@ async function upload_to_release(
|
||||
return
|
||||
}
|
||||
const file_size = stat.size
|
||||
const file_bytes = fs.readFileSync(file)
|
||||
if (file_size === 0) {
|
||||
core.debug(`Skipping ${file}, since its size is 0`)
|
||||
return
|
||||
}
|
||||
|
||||
// Check for duplicates.
|
||||
const assets: RepoAssetsResp = await octokit.repos.listReleaseAssets({
|
||||
...github.context.repo,
|
||||
const assets: RepoAssetsResp = await octokit.paginate(repoAssets, {
|
||||
...repo(),
|
||||
release_id: release.data.id
|
||||
})
|
||||
const duplicate_asset = assets.data.find(a => a.name === asset_name)
|
||||
const duplicate_asset = assets.find(a => a.name === asset_name)
|
||||
if (duplicate_asset !== undefined) {
|
||||
if (overwrite) {
|
||||
core.debug(
|
||||
`An asset called ${asset_name} already exists in release ${tag} so we'll overwrite it.`
|
||||
)
|
||||
await octokit.repos.deleteReleaseAsset({
|
||||
...github.context.repo,
|
||||
await octokit.request(deleteAssets, {
|
||||
...repo(),
|
||||
asset_id: duplicate_asset.id
|
||||
})
|
||||
} else {
|
||||
@ -85,20 +157,47 @@ async function upload_to_release(
|
||||
}
|
||||
|
||||
core.debug(`Uploading ${file} to ${asset_name} in release ${tag}.`)
|
||||
const uploaded_asset: UploadAssetResp = await octokit.repos.uploadReleaseAsset(
|
||||
const uploaded_asset: UploadAssetResp = await retry(
|
||||
async () => {
|
||||
return octokit.request(uploadAssets, {
|
||||
...repo(),
|
||||
release_id: release.data.id,
|
||||
url: release.data.upload_url,
|
||||
name: asset_name,
|
||||
data: fs.createReadStream(file) as any,
|
||||
headers: {
|
||||
'content-type': 'binary/octet-stream',
|
||||
'content-length': file_size
|
||||
}
|
||||
})
|
||||
},
|
||||
{
|
||||
url: release.data.upload_url,
|
||||
name: asset_name,
|
||||
data: file_bytes,
|
||||
headers: {
|
||||
'content-type': 'binary/octet-stream',
|
||||
'content-length': file_size
|
||||
}
|
||||
maxAttempts: 3
|
||||
}
|
||||
)
|
||||
return uploaded_asset.data.browser_download_url
|
||||
}
|
||||
|
||||
function repo(): {owner: string; repo: string} {
|
||||
const repo_name = core.getInput('repo_name')
|
||||
// If we're not targeting a foreign repository, we can just return immediately and don't have to do extra work.
|
||||
if (!repo_name) {
|
||||
return github.context.repo
|
||||
}
|
||||
const owner = repo_name.substring(0, repo_name.indexOf('/'))
|
||||
if (!owner) {
|
||||
throw new Error(`Could not extract 'owner' from 'repo_name': ${repo_name}.`)
|
||||
}
|
||||
const repo_ = repo_name.substring(repo_name.indexOf('/') + 1)
|
||||
if (!repo_) {
|
||||
throw new Error(`Could not extract 'repo' from 'repo_name': ${repo_name}.`)
|
||||
}
|
||||
return {
|
||||
owner,
|
||||
repo: repo_
|
||||
}
|
||||
}
|
||||
|
||||
async function run(): Promise<void> {
|
||||
try {
|
||||
// Get the inputs from the workflow file: https://github.com/actions/toolkit/tree/master/packages/core#inputsoutputs
|
||||
@ -111,27 +210,40 @@ async function run(): Promise<void> {
|
||||
|
||||
const file_glob = core.getInput('file_glob') == 'true' ? true : false
|
||||
const overwrite = core.getInput('overwrite') == 'true' ? true : false
|
||||
const promote = core.getInput('promote') == 'true' ? true : false
|
||||
const draft = core.getInput('draft') == 'true' ? true : false
|
||||
const prerelease = core.getInput('prerelease') == 'true' ? true : false
|
||||
const make_latest = core.getInput('make_latest') != 'false' ? true : false
|
||||
const release_name = core.getInput('release_name')
|
||||
const body = core.getInput('body')
|
||||
const target_commit = core.getInput('target_commit')
|
||||
const body = core
|
||||
.getInput('body')
|
||||
.replace(/%0A/gi, '\n')
|
||||
.replace(/%0D/gi, '\r')
|
||||
.replace(/%25/g, '%')
|
||||
|
||||
const octokit: Octokit = github.getOctokit(token)
|
||||
const octokit = github.getOctokit(token)
|
||||
const release = await get_release_by_tag(
|
||||
tag,
|
||||
draft,
|
||||
prerelease,
|
||||
make_latest,
|
||||
release_name,
|
||||
body,
|
||||
octokit
|
||||
octokit,
|
||||
overwrite,
|
||||
promote,
|
||||
target_commit
|
||||
)
|
||||
|
||||
if (file_glob) {
|
||||
const files = glob.sync(file)
|
||||
if (files.length > 0) {
|
||||
for (const file of files) {
|
||||
const asset_name = path.basename(file)
|
||||
for (const file_ of files) {
|
||||
const asset_name = path.basename(file_)
|
||||
const asset_download_url = await upload_to_release(
|
||||
release,
|
||||
file,
|
||||
file_,
|
||||
asset_name,
|
||||
tag,
|
||||
overwrite,
|
||||
@ -157,7 +269,7 @@ async function run(): Promise<void> {
|
||||
)
|
||||
core.setOutput('browser_download_url', asset_download_url)
|
||||
}
|
||||
} catch (error) {
|
||||
} catch (error: any) {
|
||||
core.setFailed(error.message)
|
||||
}
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user