1 Commits

Author SHA1 Message Date
Nick Cipollo
18eadf9c9b Prepare 1.11.2
Some checks failed
Test / check_pr (push) Has been cancelled
2022-11-11 14:17:14 -05:00
62 changed files with 12920 additions and 39075 deletions

View File

@@ -11,15 +11,11 @@ jobs:
check_pr: check_pr:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v3
- uses: actions/setup-node@v4
with:
node-version: 20
- name: "yarn install" - name: "yarn install"
run: yarn install run: yarn install
- name: "yarn build" - name: "yarn build"
run: yarn build run: yarn build

View File

@@ -1,22 +0,0 @@
name: Release
on:
push:
tags:
- '*'
jobs:
create_release:
if: github.ref != 'refs/tags/v1'
runs-on: ubuntu-latest
name: Create Release
steps:
- uses: actions/checkout@v4
- name: Create Release
id: create_release
uses: ncipollo/release-action@v1
with:
allowUpdates: true
draft: true
generateReleaseNotes: true

View File

@@ -5,11 +5,7 @@ jobs:
check_pr: check_pr:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v3
- uses: actions/setup-node@v4
with:
node-version: 20
- name: "yarn install" - name: "yarn install"
run: yarn install run: yarn install

6
.gitignore vendored
View File

@@ -1,6 +1,5 @@
node_modules/ node_modules/
__tests__/runner/* __tests__/runner/*
.DS_Store
# Created by https://www.gitignore.io/api/webstorm # Created by https://www.gitignore.io/api/webstorm
# Edit at https://www.gitignore.io/?templates=webstorm # Edit at https://www.gitignore.io/?templates=webstorm
@@ -96,7 +95,4 @@ fabric.properties
# End of https://www.gitignore.io/api/webstorm # End of https://www.gitignore.io/api/webstorm
# Coverage # Coverage
coverage coverage
# Ignore lib, it contains intermediates
/lib

6
.idea/biome.xml generated
View File

@@ -1,6 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="BiomeSettings">
<option name="enableLspFormat" value="true" />
</component>
</project>

View File

@@ -13,45 +13,41 @@ This action will create a GitHub release and optionally upload an artifact to it
</div> </div>
## Action Inputs ## Action Inputs
| Input name | Description | Required | Default Value | | Input name | Description | Required | Default Value |
|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|----------------------| |----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|----------------------|
| allowUpdates | An optional flag which indicates if we should update a release if it already exists. Defaults to false. | false | "" | | allowUpdates | An optional flag which indicates if we should update a release if it already exists. Defaults to false. | false | "" |
| artifactErrorsFailBuild | An optional flag which indicates if artifact read or upload errors should fail the build. | false | "" | | artifactErrorsFailBuild | An optional flag which indicates if artifact read or upload errors should fail the build. | false | "" |
| artifacts | An optional set of paths representing artifacts to upload to the release. This may be a single path or a comma delimited list of paths (or globs) | false | "" | | artifacts | An optional set of paths representing artifacts to upload to the release. This may be a single path or a comma delimited list of paths (or globs) | false | "" |
| artifactContentType | The content type of the artifact. Defaults to raw | false | "" | | artifactContentType | The content type of the artifact. Defaults to raw | false | "" |
| body | An optional body for the release. Note: This input will have white space trimmed before and after it. Use `bodyFile` if you need a non-trivial markdown body. | false | "" | | body | An optional body for the release. | false | "" |
| bodyFile | An optional body file for the release. This should be the path to the file. | false | "" | | bodyFile | An optional body file for the release. This should be the path to the file. | false | "" |
| commit | An optional commit reference. This will be used to create the tag if it does not exist. | false | "" | | commit | An optional commit reference. This will be used to create the tag if it does not exist. | false | "" |
| discussionCategory | When provided this will generate a discussion of the specified category. The category must exist otherwise this will cause the action to fail. This isn't used with draft releases. The default "Announcements" category is not supported via the API and will cause an error if used here. | false | "" | | discussionCategory | When provided this will generate a discussion of the specified category. The category must exist otherwise this will cause the action to fail. This isn't used with draft releases | false | "" |
| draft | Optionally marks this release as a draft release. Set to true to enable. | false | "" | | draft | Optionally marks this release as a draft release. Set to true to enable. | false | "" |
| generateReleaseNotes | Indicates if release notes should be automatically generated. | false | false | | generateReleaseNotes | Indicates if release notes should be automatically generated. | false | false |
| makeLatest | Indicates if the release should be the "latest" release or not. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version. | false | "legacy" | | name | An optional name for the release. If this is omitted the tag will be used. | false | "" |
| name | An optional name for the release. If this is omitted the tag will be used. | false | "" | | omitBody | Indicates if the release body should be omitted. | false | false |
| omitBody | Indicates if the release body should be omitted. | false | false | | omitBodyDuringUpdate | Indicates if the release body should be omitted during updates. The body will still be applied for newly created releases. This will preserve the existing body during updates. | false | false |
| omitBodyDuringUpdate | Indicates if the release body should be omitted during updates. The body will still be applied for newly created releases. This will preserve the existing body during updates. | false | false | | omitDraftDuringUpdate | Indicates if the draft flag should be omitted during updates. The draft flag will still be applied for newly created releases. This will preserve the existing draft state during updates. | false | false |
| omitDraftDuringUpdate | Indicates if the draft flag should be omitted during updates. The draft flag will still be applied for newly created releases. This will preserve the existing draft state during updates. | false | false | | omitName | Indicates if the release name should be omitted. | false | false |
| omitName | Indicates if the release name should be omitted. | false | false | | omitNameDuringUpdate | Indicates if the release name should be omitted during updates. The name will still be applied for newly created releases. This will preserve the existing name during updates. | false | false |
| omitNameDuringUpdate | Indicates if the release name should be omitted during updates. The name will still be applied for newly created releases. This will preserve the existing name during updates. | false | false | | omitPrereleaseDuringUpdate | Indicates if the prerelease flag should be omitted during updates. The prerelease flag will still be applied for newly created releases. This will preserve the existing prerelease state during updates. | false | false |
| omitPrereleaseDuringUpdate | Indicates if the prerelease flag should be omitted during updates. The prerelease flag will still be applied for newly created releases. This will preserve the existing prerelease state during updates. | false | false | | owner | Optionally specify the owner of the repo where the release should be generated. Defaults to current repo's owner. | false | "current repo owner" |
| owner | Optionally specify the owner of the repo where the release should be generated. Defaults to current repo's owner. | false | "current repo owner" | | prerelease | Optionally marks this release as prerelease. Set to true to enable. | false | "" |
| prerelease | Optionally marks this release as prerelease. Set to true to enable. | false | "" | | removeArtifacts | Indicates if existing release artifacts should be removed. | false | false |
| removeArtifacts | Indicates if existing release artifacts should be removed. | false | false | | replacesArtifacts | Indicates if existing release artifacts should be replaced. | false | true |
| replacesArtifacts | Indicates if existing release artifacts should be replaced. | false | true | | repo | Optionally specify the repo where the release should be generated. | false | current repo |
| repo | Optionally specify the repo where the release should be generated. | false | current repo | | skipIfReleaseExists | When skipIfReleaseExists is enabled the action will be skipped if a non-draft release already exists for the provided tag. | false | current repo |
| skipIfReleaseExists | When skipIfReleaseExists is enabled the action will be skipped if a non-draft release already exists for the provided tag. | false | false | | tag | An optional tag for the release. If this is omitted the git ref will be used (if it is a tag). | false | "" |
| tag | An optional tag for the release. If this is omitted the git ref will be used (if it is a tag). | false | "" | | token | The GitHub token. This will default to the GitHub app token. This is primarily useful if you want to use your personal token (for targeting other repos, etc). If you are using a personal access token it should have access to the `repo` scope. | false | github.token |
| token | The GitHub token. This will default to the GitHub app token. This is primarily useful if you want to use your personal token (for targeting other repos, etc). If you are using a personal access token it should have access to the `repo` scope. | false | github.token | | updateOnlyUnreleased | When allowUpdates is enabled, this will fail the action if the release it is updating is not a draft or a prerelease. | false | false |
| updateOnlyUnreleased | When allowUpdates is enabled, this will fail the action if the release it is updating is not a draft or a prerelease. | false | false |
## Action Outputs ## Action Outputs
| Output name | Description | | Output name | Description |
|-------------|-----------------------------------------------| |-------------|-----------------------------------------------|
| id | The identifier of the created release. | | id | The identifier of the created release. |
| html_url | The HTML URL of the release. | | html_url | The HTML URL of the release. |
| upload_url | The URL for [uploading assets](https://docs.github.com/en/rest/releases/assets?apiVersion=2022-11-28#upload-a-release-asset) to the release. | | upload_url | The URL for uploading assets to the release. |
| tarball_url | The URL for downloading the release as a tarball (.tar.gz). |
| zipball_url | The URL for downloading the release as a zipball (.zip). |
| assets | JSON string containing a map of asset names to download URLs for uploaded assets. |
## Example ## Example
This example will create a release when a tag is pushed: This example will create a release when a tag is pushed:
@@ -71,7 +67,7 @@ jobs:
permissions: permissions:
contents: write contents: write
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v2
- uses: ncipollo/release-action@v1 - uses: ncipollo/release-action@v1
with: with:
artifacts: "release.tar.gz,foo/*.txt" artifacts: "release.tar.gz,foo/*.txt"
@@ -82,4 +78,3 @@ jobs:
- You must provide a tag either via the action input or the git ref (i.e push / create a tag). If you do not provide a tag the action will fail. - You must provide a tag either via the action input or the git ref (i.e push / create a tag). If you do not provide a tag the action will fail.
- If the tag of the release you are creating does not yet exist, you should set both the `tag` and `commit` action inputs. `commit` can point to a commit hash or a branch name (ex - `main`). - If the tag of the release you are creating does not yet exist, you should set both the `tag` and `commit` action inputs. `commit` can point to a commit hash or a branch name (ex - `main`).
- In the example above only required permissions for the action specified (which is `contents: write`). If you add other actions to the same workflow you should expand `permissions` block accordingly. - In the example above only required permissions for the action specified (which is `contents: write`). If you add other actions to the same workflow you should expand `permissions` block accordingly.
- More info about why the default discussion category "Announcements" does not work with this action may be found here: https://github.com/goreleaser/goreleaser/issues/2304.

View File

@@ -20,13 +20,12 @@
| artifactErrorsFailBuild | 一个可选标志,表示读取或上传产出文件错误时是否应该使构建失败。 | false | "" | | artifactErrorsFailBuild | 一个可选标志,表示读取或上传产出文件错误时是否应该使构建失败。 | false | "" |
| artifacts | 一组可选的路径,表示要上传到版本的产出文件。 这可能是单个路径或以逗号分隔的路径列表(或 globs | false | "" | | artifacts | 一组可选的路径,表示要上传到版本的产出文件。 这可能是单个路径或以逗号分隔的路径列表(或 globs | false | "" |
| artifactContentType | 产出文件的内容类型。 默认为 raw | false | "" | | artifactContentType | 产出文件的内容类型。 默认为 raw | false | "" |
| body | 发布的可选主体。注意:此处输入的首尾空格会被去除。如果您需要特殊的 markdown 内容,请使用 `bodyFile` | false | "" | | body | 发布的可选主体。 | false | "" |
| bodyFile | 发布的可选正文文件。 这应该是文件的路径。 | false | "" | | bodyFile | 发布的可选正文文件。 这应该是文件的路径。 | false | "" |
| commit | 一个可选的提交 ref。 如果标签不存在,将用于创建标签。 | false | "" | | commit | 一个可选的提交 ref。 如果标签不存在,将用于创建标签。 | false | "" |
| discussionCategory | 当提供该选项时,将生成指定类别的 discussion。指定的类别必须存在,否则将导致 Action 失败。这草案状态的发布不生效。API 不支持默认的 Announcement 分类,使用这个分类会引发错误。 | false | "" | | discussionCategory | 当提供该选项时,将生成指定类别的 discussion。类别必须存在否则将导致 Action 失败。这草案发布中没有使用 | false | "" |
| draft | 可选择将此版本标记为草稿版本。 设置为 true 以启用。 | false | "" | | draft | 可选择将此版本标记为草稿版本。 设置为 true 以启用。 | false | "" |
| generateReleaseNotes | 指示是否应自动生成发行说明。 | false | false | | generateReleaseNotes | 指示是否应自动生成发行说明。 | false | false |
| makeLatest | 指示是否将这个发布设置为 latest。使用"lagecy"值则会根据发布时间和语义化版本号自动决定。 | false | "legacy" |
| name | 版本的可选名称。 如果省略,将使用标签。 | false | "" | | name | 版本的可选名称。 如果省略,将使用标签。 | false | "" |
| omitBody | 指示是否应省略发布主体。 | false | false | | omitBody | 指示是否应省略发布主体。 | false | false |
| omitBodyDuringUpdate | 指示在更新期间是否应省略发布主体。 正文仍将应用于新创建的版本。 这将在更新期间保留现有正文。 | false | false | | omitBodyDuringUpdate | 指示在更新期间是否应省略发布主体。 正文仍将应用于新创建的版本。 这将在更新期间保留现有正文。 | false | false |
@@ -39,7 +38,6 @@
| removeArtifacts | 指示是否应删除现有的发布产出文件。 | false | false | | removeArtifacts | 指示是否应删除现有的发布产出文件。 | false | false |
| replacesArtifacts | 指示是否应替换现有的发布产出文件。 | false | true | | replacesArtifacts | 指示是否应替换现有的发布产出文件。 | false | true |
| repo | (可选)指定应在其中生成版本的存储库。 | false | current repo | | repo | (可选)指定应在其中生成版本的存储库。 | false | current repo |
| skipIfReleaseExists | 当该选项启用时,如果提供的标签已存在一个对应的非草案状态的发布,则 action 将会被跳过。 | false | false |
| tag | 发布的可选标签。 如果省略,将使用 git ref (如果它是标签)。 | false | "" | | tag | 发布的可选标签。 如果省略,将使用 git ref (如果它是标签)。 | false | "" |
| token | GitHub 令牌。 这将默认为 GitHub 应用程序令牌。 如果您想使用您的个人令牌(用于定位其他存储库等),这主要是有用的。 如果您使用的是个人访问令牌,它应该可以访问 `repo` 范围。 | false | github.token | | token | GitHub 令牌。 这将默认为 GitHub 应用程序令牌。 如果您想使用您的个人令牌(用于定位其他存储库等),这主要是有用的。 如果您使用的是个人访问令牌,它应该可以访问 `repo` 范围。 | false | github.token |
| updateOnlyUnreleased | 启用 allowUpdates 后,如果它正在更新的版本不是草稿或预发布,则该操作将失败。 | false | false | | updateOnlyUnreleased | 启用 allowUpdates 后,如果它正在更新的版本不是草稿或预发布,则该操作将失败。 | false | false |
@@ -62,20 +60,20 @@ name: Releases
on: on:
push: push:
tags: tags:
- '*' - "*"
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions: permissions:
contents: write contents: write
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v2
- uses: ncipollo/release-action@v1 - uses: ncipollo/release-action@v1
with: with:
artifacts: "release.tar.gz,foo/*.txt" artifacts: "release.tar.gz,foo/*.txt"
bodyFile: "body.md" bodyFile: "body.md"
token: ${{ secrets.YOUR_GITHUB_TOKEN }}
``` ```
## 注意 ## 注意
@@ -83,4 +81,3 @@ jobs:
- 您必须通过 Action 输入或 git ref 提供一个标签(即推送/创建标签。如果不提供标签Action 将会失败。 - 您必须通过 Action 输入或 git ref 提供一个标签(即推送/创建标签。如果不提供标签Action 将会失败。
- 如果您正在创建的版本的标签不存在,您应该同时设置标签和提交 Action 输入。 commit 可以指向提交 Hash 或分支名称(例如 - main - 如果您正在创建的版本的标签不存在,您应该同时设置标签和提交 Action 输入。 commit 可以指向提交 Hash 或分支名称(例如 - main
- 在上面的示例中,只需要指定操作的权限(即 contents: write。 如果您将其他操作添加到同一工作流程,则应相应地扩展权限。 - 在上面的示例中,只需要指定操作的权限(即 contents: write。 如果您将其他操作添加到同一工作流程,则应相应地扩展权限。
- 有关于此 action 无法支持 discussion 的 Announcement 分类的原因的更多信息请参见此处https://github.com/goreleaser/goreleaser/issues/2304

View File

@@ -1,21 +1,13 @@
import { Action } from "../src/Action" import {Action} from "../src/Action";
import type { ActionSkipper } from "../src/ActionSkipper" import {Artifact} from "../src/Artifact";
import { Artifact } from "../src/Artifact" import {Inputs} from "../src/Inputs";
import type { ArtifactDestroyer } from "../src/ArtifactDestroyer" import {Releases} from "../src/Releases";
import type { ArtifactUploader } from "../src/ArtifactUploader" import {ArtifactUploader} from "../src/ArtifactUploader";
import type { Inputs } from "../src/Inputs" import {Outputs} from "../src/Outputs";
import type { Outputs } from "../src/Outputs" import {ArtifactDestroyer} from "../src/ArtifactDestroyer";
import type { Releases } from "../src/Releases" import {ActionSkipper} from "../src/ActionSkipper";
const TEST_URLS = {
UPLOAD_URL: "http://api.example.com",
HTML_URL: "https://github.com/owner/repo/releases/tag/v1.0.0",
TARBALL_URL: "https://api.github.com/repos/owner/repo/tarball/v1.0.0",
ZIPBALL_URL: "https://api.github.com/repos/owner/repo/zipball/v1.0.0",
} as const
const applyReleaseDataMock = jest.fn() const applyReleaseDataMock = jest.fn()
const applyAssetUrlsMock = jest.fn()
const artifactDestroyMock = jest.fn() const artifactDestroyMock = jest.fn()
const createMock = jest.fn() const createMock = jest.fn()
const deleteMock = jest.fn() const deleteMock = jest.fn()
@@ -25,35 +17,33 @@ const listMock = jest.fn()
const shouldSkipMock = jest.fn() const shouldSkipMock = jest.fn()
const updateMock = jest.fn() const updateMock = jest.fn()
const uploadMock = jest.fn() const uploadMock = jest.fn()
const genReleaseNotesMock = jest.fn()
const artifacts = [new Artifact("a/art1"), new Artifact("b/art2")] const artifacts = [
new Artifact('a/art1'),
new Artifact('b/art2')
]
const createBody = "createBody" const createBody = 'createBody'
const createDraft = true const createDraft = true
const createName = "createName" const createName = 'createName'
const commit = "commit" const commit = 'commit'
const discussionCategory = "discussionCategory" const discussionCategory = 'discussionCategory'
const generateReleaseNotes = true const generateReleaseNotes = true
const id = 100 const id = 100
const createPrerelease = true const createPrerelease = true
const releaseId = 101 const releaseId = 101
const replacesArtifacts = true const replacesArtifacts = true
const tag = "tag" const tag = 'tag'
const token = "token" const token = 'token'
const updateBody = "updateBody" const updateBody = 'updateBody'
const updateDraft = false const updateDraft = false
const updateName = "updateName" const updateName = 'updateName'
const updatePrerelease = false const updatePrerelease = false
const updateOnlyUnreleased = false const updateOnlyUnreleased = false
const url = TEST_URLS.UPLOAD_URL const url = 'http://api.example.com'
const makeLatest = "legacy"
const generatedReleaseBody = "test release notes"
describe("Action", () => { describe("Action", () => {
beforeEach(() => { beforeEach(() => {
applyReleaseDataMock.mockClear()
applyAssetUrlsMock.mockClear()
createMock.mockClear() createMock.mockClear()
getMock.mockClear() getMock.mockClear()
listMock.mockClear() listMock.mockClear()
@@ -62,143 +52,118 @@ describe("Action", () => {
uploadMock.mockClear() uploadMock.mockClear()
}) })
it("creates release but does not upload if no artifact", async () => { it('creates release but does not upload if no artifact', async () => {
const action = createAction(false, false) const action = createAction(false, false)
await action.perform() await action.perform()
expect(createMock).toHaveBeenCalledWith( expect(createMock).toBeCalledWith(tag,
tag,
createBody, createBody,
commit, commit,
discussionCategory, discussionCategory,
createDraft, createDraft,
generateReleaseNotes, generateReleaseNotes,
makeLatest,
createName, createName,
createPrerelease createPrerelease)
) expect(uploadMock).not.toBeCalled()
expect(uploadMock).not.toHaveBeenCalled()
assertOutputApplied() assertOutputApplied()
assertAssetUrlsApplied({})
}) })
it("creates release if no release exists to update", async () => { it('creates release if no release exists to update', async () => {
const action = createAction(true, true) const action = createAction(true, true)
const error = { status: 404 } const error = {status: 404}
getMock.mockRejectedValue(error) getMock.mockRejectedValue(error)
await action.perform() await action.perform()
expect(createMock).toHaveBeenCalledWith( expect(createMock).toBeCalledWith(
tag, tag,
createBody, createBody,
commit, commit,
discussionCategory, discussionCategory,
createDraft, createDraft,
generateReleaseNotes, generateReleaseNotes,
makeLatest,
createName, createName,
createPrerelease createPrerelease)
) expect(uploadMock).toBeCalledWith(artifacts, releaseId, url)
expect(uploadMock).toHaveBeenCalledWith(artifacts, releaseId, url)
assertOutputApplied() assertOutputApplied()
assertAssetUrlsApplied({
"art1": "https://github.com/owner/repo/releases/download/v1.0.0/art1",
"art2": "https://github.com/owner/repo/releases/download/v1.0.0/art2",
})
}) })
it("creates release if no draft releases", async () => { it('creates release if no draft releases', async () => {
const action = createAction(true, true) const action = createAction(true, true)
const error = { status: 404 } const error = {status: 404}
getMock.mockRejectedValue(error) getMock.mockRejectedValue(error)
listMock.mockResolvedValue({ listMock.mockResolvedValue({
data: [{ id: id, draft: false, tag_name: tag }], data: [
{id: id, draft: false, tag_name: tag}
]
}) })
await action.perform() await action.perform()
expect(createMock).toHaveBeenCalledWith( expect(createMock).toBeCalledWith(
tag, tag,
createBody, createBody,
commit, commit,
discussionCategory, discussionCategory,
createDraft, createDraft,
generateReleaseNotes, generateReleaseNotes,
makeLatest,
createName, createName,
createPrerelease createPrerelease
) )
expect(uploadMock).toHaveBeenCalledWith(artifacts, releaseId, url) expect(uploadMock).toBeCalledWith(artifacts, releaseId, url)
assertOutputApplied() assertOutputApplied()
assertAssetUrlsApplied({
"art1": "https://github.com/owner/repo/releases/download/v1.0.0/art1",
"art2": "https://github.com/owner/repo/releases/download/v1.0.0/art2",
})
}) })
it("creates release then uploads artifact", async () => { it('creates release then uploads artifact', async () => {
const action = createAction(false, true) const action = createAction(false, true)
await action.perform() await action.perform()
expect(createMock).toHaveBeenCalledWith( expect(createMock).toBeCalledWith(
tag, tag,
createBody, createBody,
commit, commit,
discussionCategory, discussionCategory,
createDraft, createDraft,
generateReleaseNotes, generateReleaseNotes,
makeLatest,
createName, createName,
createPrerelease createPrerelease
) )
expect(uploadMock).toHaveBeenCalledWith(artifacts, releaseId, url) expect(uploadMock).toBeCalledWith(artifacts, releaseId, url)
assertOutputApplied() assertOutputApplied()
assertAssetUrlsApplied({
"art1": "https://github.com/owner/repo/releases/download/v1.0.0/art1",
"art2": "https://github.com/owner/repo/releases/download/v1.0.0/art2",
})
}) })
it("removes all artifacts when artifact destroyer is enabled", async () => { it('removes all artifacts when artifact destroyer is enabled', async () => {
const action = createAction(false, true, true) const action = createAction(false, true, true)
await action.perform() await action.perform()
expect(artifactDestroyMock).toHaveBeenCalledWith(releaseId) expect(artifactDestroyMock).toBeCalledWith(releaseId)
assertOutputApplied() assertOutputApplied()
assertAssetUrlsApplied({
"art1": "https://github.com/owner/repo/releases/download/v1.0.0/art1",
"art2": "https://github.com/owner/repo/releases/download/v1.0.0/art2",
})
}) })
it("removes no artifacts when artifact destroyer is disabled", async () => { it('removes no artifacts when artifact destroyer is disabled', async () => {
const action = createAction(false, true) const action = createAction(false, true)
await action.perform() await action.perform()
expect(artifactDestroyMock).not.toHaveBeenCalled() expect(artifactDestroyMock).not.toBeCalled()
assertOutputApplied() assertOutputApplied()
assertAssetUrlsApplied({
"art1": "https://github.com/owner/repo/releases/download/v1.0.0/art1",
"art2": "https://github.com/owner/repo/releases/download/v1.0.0/art2",
})
}) })
it("skips action", async () => { it('skips action', async () => {
const action = createAction(false, false, false) const action = createAction(false, false, false)
shouldSkipMock.mockResolvedValue(true) shouldSkipMock.mockResolvedValue(true)
await action.perform() await action.perform()
expect(createMock).not.toHaveBeenCalled() expect(createMock).not.toBeCalled()
expect(updateMock).not.toHaveBeenCalled() expect(updateMock).not.toBeCalled()
}) })
it("throws error when create fails", async () => { it('throws error when create fails', async () => {
const action = createAction(false, true) const action = createAction(false, true)
createMock.mockRejectedValue("error") createMock.mockRejectedValue("error")
@@ -209,28 +174,27 @@ describe("Action", () => {
expect(error).toEqual("error") expect(error).toEqual("error")
} }
expect(createMock).toHaveBeenCalledWith( expect(createMock).toBeCalledWith(
tag, tag,
createBody, createBody,
commit, commit,
discussionCategory, discussionCategory,
createDraft, createDraft,
generateReleaseNotes, generateReleaseNotes,
makeLatest,
createName, createName,
createPrerelease createPrerelease
) )
expect(uploadMock).not.toHaveBeenCalled() expect(uploadMock).not.toBeCalled()
}) })
it("throws error when get fails", async () => { it('throws error when get fails', async () => {
const action = createAction(true, true) const action = createAction(true, true)
const error = { const error = {
errors: [ errors: [
{ {
code: "already_exists", code: 'already_exists'
}, }
], ]
} }
createMock.mockRejectedValue(error) createMock.mockRejectedValue(error)
@@ -242,37 +206,13 @@ describe("Action", () => {
expect(error).toEqual("error") expect(error).toEqual("error")
} }
expect(getMock).toHaveBeenCalledWith(tag) expect(getMock).toBeCalledWith(tag)
expect(updateMock).not.toHaveBeenCalled() expect(updateMock).not.toBeCalled()
expect(uploadMock).not.toHaveBeenCalled() expect(uploadMock).not.toBeCalled()
}) })
it("throws error when list has no data", async () => { it('throws error when update fails', async () => {
const action = createAction(true, true)
getMock.mockRejectedValue({ status: 404 })
const error = {
errors: [
{
code: "already_exists",
},
],
}
createMock.mockRejectedValue(error)
listMock.mockResolvedValue({})
expect.hasAssertions()
try {
await action.perform()
} catch (error) {
expect(error).toEqual(Error("No releases found. Response: {}"))
}
expect(listMock).toHaveBeenCalled()
expect(createMock).not.toHaveBeenCalled()
expect(updateMock).not.toHaveBeenCalled()
})
it("throws error when update fails", async () => {
const action = createAction(true, true) const action = createAction(true, true)
updateMock.mockRejectedValue("error") updateMock.mockRejectedValue("error")
@@ -284,23 +224,22 @@ describe("Action", () => {
expect(error).toEqual("error") expect(error).toEqual("error")
} }
expect(updateMock).toHaveBeenCalledWith( expect(updateMock).toBeCalledWith(
id, id,
tag, tag,
generatedReleaseBody, updateBody,
commit, commit,
discussionCategory, discussionCategory,
updateDraft, updateDraft,
makeLatest,
updateName, updateName,
updatePrerelease updatePrerelease
) )
expect(uploadMock).not.toHaveBeenCalled() expect(uploadMock).not.toBeCalled()
}) })
it("throws error when upload fails", async () => { it('throws error when upload fails', async () => {
const action = createAction(false, true) const action = createAction(false, true)
const expectedError = { status: 404 } const expectedError = {status: 404}
uploadMock.mockRejectedValue(expectedError) uploadMock.mockRejectedValue(expectedError)
expect.hasAssertions() expect.hasAssertions()
@@ -310,190 +249,97 @@ describe("Action", () => {
expect(error).toEqual(expectedError) expect(error).toEqual(expectedError)
} }
expect(createMock).toHaveBeenCalledWith( expect(createMock).toBeCalledWith(
tag, tag,
createBody, createBody,
commit, commit,
discussionCategory, discussionCategory,
createDraft, createDraft,
generateReleaseNotes, generateReleaseNotes,
makeLatest,
createName, createName,
createPrerelease createPrerelease
) )
expect(uploadMock).toHaveBeenCalledWith(artifacts, releaseId, url) expect(uploadMock).toBeCalledWith(artifacts, releaseId, url)
}) })
it("updates draft release", async () => { it('updates draft release', async () => {
const action = createAction(true, true) const action = createAction(true, true)
const error = { status: 404 } const error = {status: 404}
getMock.mockRejectedValue(error) getMock.mockRejectedValue(error)
listMock.mockResolvedValue({ listMock.mockResolvedValue({
data: [ data: [
{ id: 123, draft: false, tag_name: tag }, {id: 123, draft: false, tag_name: tag},
{ id: id, draft: true, tag_name: tag }, {id: id, draft: true, tag_name: tag}
], ]
}) })
await action.perform() await action.perform()
expect(updateMock).toHaveBeenCalledWith( expect(updateMock).toBeCalledWith(
id,
tag,
generatedReleaseBody,
commit,
discussionCategory,
updateDraft,
makeLatest,
updateName,
updatePrerelease
)
expect(uploadMock).toHaveBeenCalledWith(artifacts, releaseId, url)
assertOutputApplied()
assertAssetUrlsApplied({
"art1": "https://github.com/owner/repo/releases/download/v1.0.0/art1",
"art2": "https://github.com/owner/repo/releases/download/v1.0.0/art2",
})
})
it("updates draft release with static body", async () => {
const action = createAction(true, true, false, false)
const error = { status: 404 }
getMock.mockRejectedValue(error)
listMock.mockResolvedValue({
data: [
{ id: 123, draft: false, tag_name: tag },
{ id: id, draft: true, tag_name: tag },
],
})
await action.perform()
expect(updateMock).toHaveBeenCalledWith(
id, id,
tag, tag,
updateBody, updateBody,
commit, commit,
discussionCategory, discussionCategory,
updateDraft, updateDraft,
makeLatest,
updateName, updateName,
updatePrerelease updatePrerelease
) )
expect(uploadMock).toHaveBeenCalledWith(artifacts, releaseId, url) expect(uploadMock).toBeCalledWith(artifacts, releaseId, url)
assertOutputApplied() assertOutputApplied()
assertAssetUrlsApplied({
"art1": "https://github.com/owner/repo/releases/download/v1.0.0/art1",
"art2": "https://github.com/owner/repo/releases/download/v1.0.0/art2",
})
}) })
it("updates release but does not upload if no artifact", async () => { it('updates release but does not upload if no artifact', async () => {
const action = createAction(true, false) const action = createAction(true, false)
await action.perform() await action.perform()
expect(updateMock).toHaveBeenCalledWith( expect(updateMock).toBeCalledWith(
id,
tag,
generatedReleaseBody,
commit,
discussionCategory,
updateDraft,
makeLatest,
updateName,
updatePrerelease
)
expect(uploadMock).not.toHaveBeenCalled()
assertOutputApplied()
assertAssetUrlsApplied({})
})
it("updates release then uploads artifact", async () => {
const action = createAction(true, true)
await action.perform()
expect(updateMock).toHaveBeenCalledWith(
id,
tag,
generatedReleaseBody,
commit,
discussionCategory,
updateDraft,
makeLatest,
updateName,
updatePrerelease
)
expect(uploadMock).toHaveBeenCalledWith(artifacts, releaseId, url)
assertOutputApplied()
assertAssetUrlsApplied({
"art1": "https://github.com/owner/repo/releases/download/v1.0.0/art1",
"art2": "https://github.com/owner/repo/releases/download/v1.0.0/art2",
})
})
it("updates release with static body when generateReleaseNotes is true but omitBodyDuringUpdate is true", async () => {
const action = createAction(true, true, false, true, true)
const error = { status: 404 }
getMock.mockRejectedValue(error)
listMock.mockResolvedValue({
data: [
{ id: 123, draft: false, tag_name: tag },
{ id: id, draft: true, tag_name: tag },
],
})
await action.perform()
expect(updateMock).toHaveBeenCalledWith(
id, id,
tag, tag,
updateBody, updateBody,
commit, commit,
discussionCategory, discussionCategory,
updateDraft, updateDraft,
makeLatest,
updateName, updateName,
updatePrerelease updatePrerelease
) )
expect(uploadMock).toHaveBeenCalledWith(artifacts, releaseId, url) expect(uploadMock).not.toBeCalled()
assertOutputApplied()
})
it('updates release then uploads artifact', async () => {
const action = createAction(true, true)
await action.perform()
expect(updateMock).toBeCalledWith(
id,
tag,
updateBody,
commit,
discussionCategory,
updateDraft,
updateName,
updatePrerelease
)
expect(uploadMock).toBeCalledWith(artifacts, releaseId, url)
assertOutputApplied() assertOutputApplied()
assertAssetUrlsApplied({
"art1": "https://github.com/owner/repo/releases/download/v1.0.0/art1",
"art2": "https://github.com/owner/repo/releases/download/v1.0.0/art2",
})
}) })
function assertOutputApplied() { function assertOutputApplied() {
expect(applyReleaseDataMock).toHaveBeenCalledWith({ expect(applyReleaseDataMock).toBeCalledWith({id: releaseId, upload_url: url})
id: releaseId,
upload_url: url,
html_url: TEST_URLS.HTML_URL,
tarball_url: TEST_URLS.TARBALL_URL,
zipball_url: TEST_URLS.ZIPBALL_URL,
})
} }
function assertAssetUrlsApplied(expectedUrls: Record<string, string>) { function createAction(allowUpdates: boolean,
expect(applyAssetUrlsMock).toHaveBeenCalledWith(expectedUrls) hasArtifact: boolean,
} removeArtifacts: boolean = false): Action {
function createAction(
allowUpdates: boolean,
hasArtifact: boolean,
removeArtifacts = false,
generateReleaseNotes = true,
omitBodyDuringUpdate = false
): Action {
let inputArtifact: Artifact[] let inputArtifact: Artifact[]
if (hasArtifact) { if (hasArtifact) {
inputArtifact = artifacts inputArtifact = artifacts
} else { } else {
inputArtifact = [] inputArtifact = []
} }
const MockReleases = jest.fn<Releases, any>(() => { const MockReleases = jest.fn<Releases, any>(() => {
return { return {
create: createMock, create: createMock,
@@ -502,97 +348,78 @@ describe("Action", () => {
listArtifactsForRelease: listArtifactsMock, listArtifactsForRelease: listArtifactsMock,
listReleases: listMock, listReleases: listMock,
update: updateMock, update: updateMock,
uploadArtifact: jest.fn(), uploadArtifact: jest.fn()
generateReleaseNotes: genReleaseNotesMock,
} }
}) })
createMock.mockResolvedValue({ createMock.mockResolvedValue({
data: { data: {
id: releaseId, id: releaseId,
upload_url: url, upload_url: url
html_url: TEST_URLS.HTML_URL, }
tarball_url: TEST_URLS.TARBALL_URL,
zipball_url: TEST_URLS.ZIPBALL_URL,
},
})
genReleaseNotesMock.mockResolvedValue({
data: {
body: generatedReleaseBody,
},
}) })
getMock.mockResolvedValue({ getMock.mockResolvedValue({
data: { data: {
id: id, id: id
}, }
}) })
listMock.mockResolvedValue({ listMock.mockResolvedValue({
data: [], data: []
}) })
shouldSkipMock.mockResolvedValue(false) shouldSkipMock.mockResolvedValue(false)
updateMock.mockResolvedValue({ updateMock.mockResolvedValue({
data: { data: {
id: releaseId, id: releaseId,
upload_url: url, upload_url: url
html_url: TEST_URLS.HTML_URL, }
tarball_url: TEST_URLS.TARBALL_URL,
zipball_url: TEST_URLS.ZIPBALL_URL,
},
})
uploadMock.mockResolvedValue({
"art1": "https://github.com/owner/repo/releases/download/v1.0.0/art1",
"art2": "https://github.com/owner/repo/releases/download/v1.0.0/art2",
}) })
uploadMock.mockResolvedValue({})
const MockInputs = jest.fn<Inputs, any>(() => { const MockInputs = jest.fn<Inputs, any>(() => {
return { return {
allowUpdates, allowUpdates: allowUpdates,
artifactErrorsFailBuild: true, artifactErrorsFailBuild: true,
artifacts: inputArtifact, artifacts: inputArtifact,
createdDraft: createDraft, createdDraft: createDraft,
createdReleaseBody: createBody, createdReleaseBody: createBody,
createdReleaseName: createName, createdReleaseName: createName,
commit, commit: commit,
discussionCategory, discussionCategory: discussionCategory,
generateReleaseNotes, generateReleaseNotes: true,
makeLatest: makeLatest,
owner: "owner", owner: "owner",
createdPrerelease: createPrerelease, createdPrerelease: createPrerelease,
replacesArtifacts, replacesArtifacts: replacesArtifacts,
removeArtifacts, removeArtifacts: removeArtifacts,
repo: "repo", repo: "repo",
skipIfReleaseExists: false, skipIfReleaseExists: false,
tag, tag: tag,
token, token: token,
updatedDraft: updateDraft, updatedDraft: updateDraft,
updatedReleaseBody: updateBody, updatedReleaseBody: updateBody,
updatedReleaseName: updateName, updatedReleaseName: updateName,
updatedPrerelease: updatePrerelease, updatedPrerelease: updatePrerelease,
updateOnlyUnreleased: updateOnlyUnreleased, updateOnlyUnreleased: updateOnlyUnreleased
omitBodyDuringUpdate,
} }
}) })
const MockOutputs = jest.fn<Outputs, any>(() => { const MockOutputs = jest.fn<Outputs, any>(() => {
return { return {
applyReleaseData: applyReleaseDataMock, applyReleaseData: applyReleaseDataMock
applyAssetUrls: applyAssetUrlsMock,
} }
}) })
const MockUploader = jest.fn<ArtifactUploader, any>(() => { const MockUploader = jest.fn<ArtifactUploader, any>(() => {
return { return {
uploadArtifacts: uploadMock, uploadArtifacts: uploadMock
} }
}) })
const MockArtifactDestroyer = jest.fn<ArtifactDestroyer, any>(() => { const MockArtifactDestroyer = jest.fn<ArtifactDestroyer, any>(() => {
return { return {
destroyArtifacts: artifactDestroyMock, destroyArtifacts: artifactDestroyMock
} }
}) })
const MockActionSkipper = jest.fn<ActionSkipper, any>(() => { const MockActionSkipper = jest.fn<ActionSkipper, any>(() => {
return { return {
shouldSkip: shouldSkipMock, shouldSkip: shouldSkipMock
} }
}) })

View File

@@ -1,5 +1,5 @@
import { ReleaseActionSkipper } from "../src/ActionSkipper" import {ActionSkipper, ReleaseActionSkipper} from "../src/ActionSkipper";
import type { Releases } from "../src/Releases" import {Releases} from "../src/Releases";
describe("shouldSkip", () => { describe("shouldSkip", () => {
const getMock = jest.fn() const getMock = jest.fn()
@@ -12,34 +12,33 @@ describe("shouldSkip", () => {
listArtifactsForRelease: jest.fn(), listArtifactsForRelease: jest.fn(),
listReleases: jest.fn(), listReleases: jest.fn(),
update: jest.fn(), update: jest.fn(),
uploadArtifact: jest.fn(), uploadArtifact: jest.fn()
generateReleaseNotes: jest.fn(),
} }
}) })
it("should return false when skipIfReleaseExists is false", async () => { it('should return false when skipIfReleaseExists is false', async () => {
const actionSkipper = new ReleaseActionSkipper(false, MockReleases(), tag) const actionSkipper = new ReleaseActionSkipper(false, MockReleases(), tag)
expect(await actionSkipper.shouldSkip()).toBe(false) expect(await actionSkipper.shouldSkip()).toBe(false)
}) })
it("should return false when error occurs", async () => { it('should return false when error occurs', async () => {
getMock.mockRejectedValue(new Error()) getMock.mockRejectedValue(new Error())
const actionSkipper = new ReleaseActionSkipper(true, MockReleases(), tag) const actionSkipper = new ReleaseActionSkipper(true, MockReleases(), tag)
expect(await actionSkipper.shouldSkip()).toBe(false) expect(await actionSkipper.shouldSkip()).toBe(false)
}) })
it("should return false when release does not exist", async () => { it('should return false when release does not exist', async () => {
getMock.mockResolvedValue({}) getMock.mockResolvedValue({})
const actionSkipper = new ReleaseActionSkipper(true, MockReleases(), tag) const actionSkipper = new ReleaseActionSkipper(true, MockReleases(), tag)
expect(await actionSkipper.shouldSkip()).toBe(false) expect(await actionSkipper.shouldSkip()).toBe(false)
}) })
it("should return true when release does exist", async () => { it('should return true when release does exist', async () => {
getMock.mockResolvedValue({ data: {} }) getMock.mockResolvedValue({data: {}})
const actionSkipper = new ReleaseActionSkipper(true, MockReleases(), tag) const actionSkipper = new ReleaseActionSkipper(true, MockReleases(), tag)
expect(await actionSkipper.shouldSkip()).toBe(true) expect(await actionSkipper.shouldSkip()).toBe(true)
}) })
}) })

View File

@@ -1,40 +1,38 @@
import { Artifact } from "../src/Artifact" import { Artifact } from "../src/Artifact";
const fileContents = Buffer.from('artful facts', 'utf-8')
const contentLength = 42 const contentLength = 42
const fakeReadStream = {}
jest.mock("fs", () => { jest.mock('fs', () => {
return { return {
createReadStream: () => fakeReadStream, readFileSync: () => fileContents,
statSync: () => { statSync: () => { return { size: contentLength } }
return { size: contentLength } };
},
}
}) })
describe("Artifact", () => { describe("Artifact", () => {
it("defaults contentType to raw", () => { it('defaults contentType to raw', () => {
const artifact = new Artifact("") const artifact = new Artifact('')
expect(artifact.contentType).toBe("raw") expect(artifact.contentType).toBe('raw')
}) })
it("generates name from path", () => { it('generates name from path', () => {
const artifact = new Artifact("some/artifact") const artifact = new Artifact('some/artifact')
expect(artifact.name).toBe("artifact") expect(artifact.name).toBe('artifact')
}) })
it("provides contentLength", () => { it('provides contentLength', () => {
const artifact = new Artifact("some/artifact") const artifact = new Artifact('some/artifact')
expect(artifact.contentLength).toBe(contentLength) expect(artifact.contentLength).toBe(contentLength)
}) })
it("provides path", () => { it('provides path', () => {
const artifact = new Artifact("some/artifact") const artifact = new Artifact('some/artifact')
expect(artifact.path).toBe("some/artifact") expect(artifact.path).toBe('some/artifact')
}) })
it("reads artifact", () => { it('reads artifact', () => {
const artifact = new Artifact("some/artifact") const artifact = new Artifact('some/artifact')
expect(artifact.readFile()).toBe(fakeReadStream) expect(artifact.readFile()).toBe(fileContents)
}) })
}) })

View File

@@ -1,41 +1,45 @@
import { GithubArtifactDestroyer } from "../src/ArtifactDestroyer" import {Artifact} from "../src/Artifact"
import type { Releases } from "../src/Releases" import {GithubArtifactUploader} from "../src/ArtifactUploader"
import {Releases} from "../src/Releases";
import {RequestError} from '@octokit/request-error'
import {GithubArtifactDestroyer} from "../src/ArtifactDestroyer";
const releaseId = 100 const releaseId = 100
const deleteMock = jest.fn() const deleteMock = jest.fn()
const listArtifactsMock = jest.fn() const listArtifactsMock = jest.fn()
describe("ArtifactDestroyer", () => {
describe('ArtifactDestroyer', () => {
beforeEach(() => { beforeEach(() => {
deleteMock.mockClear() deleteMock.mockClear()
listArtifactsMock.mockClear() listArtifactsMock.mockClear()
}) })
it("destroys all artifacts", async () => { it('destroys all artifacts', async () => {
mockListWithAssets() mockListWithAssets()
mockDeleteSuccess() mockDeleteSuccess()
const destroyer = createDestroyer() const destroyer = createDestroyer()
await destroyer.destroyArtifacts(releaseId) await destroyer.destroyArtifacts(releaseId)
expect(deleteMock).toHaveBeenCalledTimes(2) expect(deleteMock).toBeCalledTimes(2)
}) })
it("destroys nothing when no artifacts found", async () => { it('destroys nothing when no artifacts found', async () => {
mockListWithoutAssets() mockListWithoutAssets()
const destroyer = createDestroyer() const destroyer = createDestroyer()
await destroyer.destroyArtifacts(releaseId) await destroyer.destroyArtifacts(releaseId)
expect(deleteMock).toHaveBeenCalledTimes(0) expect(deleteMock).toBeCalledTimes(0)
}) })
it("throws when delete call fails", async () => { it('throws when delete call fails', async () => {
mockListWithAssets() mockListWithAssets()
mockDeleteError() mockDeleteError()
const destroyer = createDestroyer() const destroyer = createDestroyer()
expect.hasAssertions() expect.hasAssertions()
try { try {
await destroyer.destroyArtifacts(releaseId) await destroyer.destroyArtifacts(releaseId)
@@ -53,8 +57,7 @@ describe("ArtifactDestroyer", () => {
listArtifactsForRelease: listArtifactsMock, listArtifactsForRelease: listArtifactsMock,
listReleases: jest.fn(), listReleases: jest.fn(),
update: jest.fn(), update: jest.fn(),
uploadArtifact: jest.fn(), uploadArtifact: jest.fn()
generateReleaseNotes: jest.fn(),
} }
}) })
return new GithubArtifactDestroyer(new MockReleases()) return new GithubArtifactDestroyer(new MockReleases())
@@ -72,16 +75,16 @@ describe("ArtifactDestroyer", () => {
listArtifactsMock.mockResolvedValue([ listArtifactsMock.mockResolvedValue([
{ {
name: "art1", name: "art1",
id: 1, id: 1
}, },
{ {
name: "art2", name: "art2",
id: 2, id: 2
}, }
]) ])
} }
function mockListWithoutAssets() { function mockListWithoutAssets() {
listArtifactsMock.mockResolvedValue([]) listArtifactsMock.mockResolvedValue([])
} }
}) });

View File

@@ -1,31 +1,28 @@
const warnMock = jest.fn() const warnMock = jest.fn()
import { FileArtifactGlobber } from "../src/ArtifactGlobber" import {FileArtifactGlobber} from "../src/ArtifactGlobber"
import { Globber } from "../src/Globber" import {Globber} from "../src/Globber";
import { Artifact } from "../src/Artifact" import {Artifact} from "../src/Artifact";
import untildify = require("untildify") import untildify = require("untildify");
const contentType = "raw" const contentType = "raw"
const globMock = jest.fn() const globMock = jest.fn()
const globResults = ["file1", "file2"] const globResults = ["file1", "file2"]
jest.mock("@actions/core", () => { jest.mock('@actions/core', () => {
return { warning: warnMock } return {warning: warnMock};
}) })
jest.mock("fs", () => { jest.mock('fs', () => {
return { return {
statSync: () => { statSync: () => {
return { return {
isDirectory(): boolean { isDirectory(): boolean {
return false return false
}, }
} }
}, }
realpathSync: () => { };
return false
},
}
}) })
describe("ArtifactGlobber", () => { describe("ArtifactGlobber", () => {
@@ -36,66 +33,79 @@ describe("ArtifactGlobber", () => {
it("expands paths in which start with a ~", () => { it("expands paths in which start with a ~", () => {
const globber = createArtifactGlobber() const globber = createArtifactGlobber()
const expectedArtifacts = globResults.map((path) => new Artifact(path, contentType)) const expectedArtifacts =
globResults.map((path) => new Artifact(path, contentType))
expect(globber.globArtifactString("~/path", "raw", false)).toEqual(expectedArtifacts) expect(globber.globArtifactString('~/path', 'raw', false))
expect(globMock).toHaveBeenCalledWith(untildify("~/path")) .toEqual(expectedArtifacts)
expect(warnMock).not.toHaveBeenCalled() expect(globMock).toBeCalledWith(untildify('~/path'))
expect(warnMock).not.toBeCalled()
}) })
it("globs simple path", () => { it("globs simple path", () => {
const globber = createArtifactGlobber() const globber = createArtifactGlobber()
const expectedArtifacts = globResults.map((path) => new Artifact(path, contentType)) const expectedArtifacts =
globResults.map((path) => new Artifact(path, contentType))
expect(globber.globArtifactString("path", "raw", false)).toEqual(expectedArtifacts) expect(globber.globArtifactString('path', 'raw', false))
expect(globMock).toHaveBeenCalledWith("path") .toEqual(expectedArtifacts)
expect(warnMock).not.toHaveBeenCalled() expect(globMock).toBeCalledWith('path')
expect(warnMock).not.toBeCalled()
}) })
it("splits multiple paths with comma separator", () => { it("splits multiple paths with comma separator", () => {
const globber = createArtifactGlobber() const globber = createArtifactGlobber()
const expectedArtifacts = globResults.concat(globResults).map((path) => new Artifact(path, contentType)) const expectedArtifacts =
globResults
.concat(globResults)
.map((path) => new Artifact(path, contentType))
expect(globber.globArtifactString("path1,path2", "raw", false)).toEqual(expectedArtifacts) expect(globber.globArtifactString('path1,path2', 'raw', false))
expect(globMock).toHaveBeenCalledWith("path1") .toEqual(expectedArtifacts)
expect(globMock).toHaveBeenCalledWith("path2") expect(globMock).toBeCalledWith('path1')
expect(warnMock).not.toHaveBeenCalled() expect(globMock).toBeCalledWith('path2')
expect(warnMock).not.toBeCalled()
}) })
it("splits multiple paths with new line separator and trims start", () => { it("splits multiple paths with new line separator and trims start", () => {
const globber = createArtifactGlobber() const globber = createArtifactGlobber()
const expectedArtifacts = globResults.concat(globResults).map((path) => new Artifact(path, contentType)) const expectedArtifacts =
globResults
.concat(globResults)
.map((path) => new Artifact(path, contentType))
expect(globber.globArtifactString("path1\n path2", "raw", false)).toEqual(expectedArtifacts) expect(globber.globArtifactString('path1\n path2', 'raw', false))
expect(globMock).toHaveBeenCalledWith("path1") .toEqual(expectedArtifacts)
expect(globMock).toHaveBeenCalledWith("path2") expect(globMock).toBeCalledWith('path1')
expect(warnMock).not.toHaveBeenCalled() expect(globMock).toBeCalledWith('path2')
expect(warnMock).not.toBeCalled()
}) })
it("warns when no glob results are produced and empty results shouldn't throw", () => { it("warns when no glob results are produced and empty results shouldn't throw", () => {
const globber = createArtifactGlobber([]) const globber = createArtifactGlobber([])
expect(globber.globArtifactString("path", "raw", false)).toEqual([]) expect(globber.globArtifactString('path', 'raw', false))
expect(warnMock).toHaveBeenCalled() .toEqual([])
expect(warnMock).toBeCalled()
}) })
it("throws when no glob results are produced and empty results shouild throw", () => { it("throws when no glob results are produced and empty results shouild throw", () => {
const globber = createArtifactGlobber([]) const globber = createArtifactGlobber([])
expect(() => { expect(() => {
globber.globArtifactString("path", "raw", true) globber.globArtifactString('path', 'raw', true)
}).toThrow() }).toThrow()
}) })
function createArtifactGlobber(results: string[] = globResults): FileArtifactGlobber { function createArtifactGlobber(results: string[] = globResults): FileArtifactGlobber {
const MockGlobber = jest.fn<Globber, any>(() => { const MockGlobber = jest.fn<Globber, any>(() => {
return { return {
glob: globMock, glob: globMock
} }
}) })
globMock.mockReturnValue(results) globMock.mockReturnValue(results)
return new FileArtifactGlobber(new MockGlobber()) return new FileArtifactGlobber(new MockGlobber())
} }
}) })

View File

@@ -1,20 +1,20 @@
const directoryMock = jest.fn() const directoryMock = jest.fn()
const warnMock = jest.fn() const warnMock = jest.fn()
import { ArtifactPathValidator } from "../src/ArtifactPathValidator" import {ArtifactPathValidator} from "../src/ArtifactPathValidator";
const pattern = "pattern" const pattern = 'pattern'
jest.mock("@actions/core", () => { jest.mock('@actions/core', () => {
return { warning: warnMock } return {warning: warnMock};
}) })
jest.mock("fs", () => { jest.mock('fs', () => {
return { return {
statSync: () => { statSync: () => {
return { isDirectory: directoryMock } return {isDirectory: directoryMock}
}, }
} };
}) })
describe("ArtifactPathValidator", () => { describe("ArtifactPathValidator", () => {
@@ -24,20 +24,20 @@ describe("ArtifactPathValidator", () => {
}) })
it("warns and filters out path which points to a directory", () => { it("warns and filters out path which points to a directory", () => {
const paths = ["path1", "path2"] const paths = ['path1', 'path2']
directoryMock.mockReturnValueOnce(true).mockReturnValueOnce(false) directoryMock.mockReturnValueOnce(true).mockReturnValueOnce(false)
const validator = new ArtifactPathValidator(false, paths, pattern) const validator = new ArtifactPathValidator(false, paths, pattern)
const result = validator.validate() const result = validator.validate()
expect(warnMock).toHaveBeenCalled() expect(warnMock).toBeCalled()
expect(result).toEqual(["path2"]) expect(result).toEqual(['path2'])
}) })
it("warns when no glob results are produced and empty results shouldn't throw", () => { it("warns when no glob results are produced and empty results shouldn't throw", () => {
const validator = new ArtifactPathValidator(false, [], pattern) const validator = new ArtifactPathValidator(false, [], pattern)
const result = validator.validate() const result = validator.validate()
expect(warnMock).toHaveBeenCalled() expect(warnMock).toBeCalled()
}) })
it("throws when no glob results are produced and empty results shouild throw", () => { it("throws when no glob results are produced and empty results shouild throw", () => {
@@ -48,7 +48,7 @@ describe("ArtifactPathValidator", () => {
}) })
it("throws when path points to directory", () => { it("throws when path points to directory", () => {
const paths = ["path1", "path2"] const paths = ['path1', 'path2']
directoryMock.mockReturnValueOnce(true).mockReturnValueOnce(false) directoryMock.mockReturnValueOnce(true).mockReturnValueOnce(false)
const validator = new ArtifactPathValidator(true, paths, pattern) const validator = new ArtifactPathValidator(true, paths, pattern)
@@ -57,4 +57,4 @@ describe("ArtifactPathValidator", () => {
validator.validate() validator.validate()
}).toThrow() }).toThrow()
}) })
}) })

View File

@@ -1,171 +1,133 @@
import { RequestError } from "@octokit/request-error" import {Artifact} from "../src/Artifact"
import { Artifact } from "../src/Artifact" import {GithubArtifactUploader} from "../src/ArtifactUploader"
import { GithubArtifactUploader } from "../src/ArtifactUploader" import {Releases} from "../src/Releases";
import type { Releases } from "../src/Releases" import {RequestError} from '@octokit/request-error'
const artifacts = [new Artifact("a/art1"), new Artifact("b/art2")] const artifacts = [
const fakeReadStream = {} new Artifact('a/art1'),
new Artifact('b/art2')
]
const fileContents = Buffer.from('artful facts', 'utf-8')
const contentLength = 42 const contentLength = 42
const releaseId = 100 const releaseId = 100
const url = "http://api.example.com" const url = 'http://api.example.com'
const deleteMock = jest.fn() const deleteMock = jest.fn()
const listArtifactsMock = jest.fn() const listArtifactsMock = jest.fn()
const uploadMock = jest.fn() const uploadMock = jest.fn()
// Mock response with browser_download_url jest.mock('fs', () => {
const mockUploadResponse = (name: string) => ({
data: {
browser_download_url: `https://github.com/octocat/Hello-World/releases/download/v1.0.0/${name}`,
name: name,
id: 1,
}
})
jest.mock("fs", () => {
const originalFs = jest.requireActual("fs")
return { return {
...originalFs,
promises: {}, promises: {},
createReadStream: () => fakeReadStream, readFileSync: () => fileContents,
statSync: () => { statSync: () => {
return { size: contentLength } return {size: contentLength}
}, }
} };
}) })
describe("ArtifactUploader", () => { describe('ArtifactUploader', () => {
beforeEach(() => { beforeEach(() => {
deleteMock.mockClear() deleteMock.mockClear()
listArtifactsMock.mockClear() listArtifactsMock.mockClear()
uploadMock.mockClear() uploadMock.mockClear()
}) })
it("returns asset URLs when upload succeeds", async () => { it('abort when upload failed with non-5xx response', async () => {
mockListWithoutAssets()
mockUploadSuccess()
const uploader = createUploader(true)
const result = await uploader.uploadArtifacts(artifacts, releaseId, url)
expect(result).toEqual({
"art1": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/art1",
"art2": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/art2",
})
expect(uploadMock).toHaveBeenCalledTimes(2)
})
it("returns empty object when no artifacts are uploaded", async () => {
const uploader = createUploader(true)
const result = await uploader.uploadArtifacts([], releaseId, url)
expect(result).toEqual({})
expect(uploadMock).toHaveBeenCalledTimes(0)
})
it("excludes failed uploads from returned URLs", async () => {
mockListWithoutAssets() mockListWithoutAssets()
mockUploadArtifact(401, 2) mockUploadArtifact(401, 2)
const uploader = createUploader(true) const uploader = createUploader(true)
const result = await uploader.uploadArtifacts(artifacts, releaseId, url) await uploader.uploadArtifacts(artifacts, releaseId, url)
expect(result).toEqual({}) expect(uploadMock).toBeCalledTimes(2)
expect(uploadMock).toHaveBeenCalledTimes(2) expect(uploadMock)
.toBeCalledWith(url, contentLength, 'raw', fileContents, 'art1', releaseId)
expect(uploadMock)
.toBeCalledWith(url, contentLength, 'raw', fileContents, 'art2', releaseId)
expect(deleteMock).toBeCalledTimes(0)
}) })
it("abort when upload failed with non-5xx response", async () => { it('abort when upload failed with 5xx response after 3 attempts', async () => {
mockListWithoutAssets()
mockUploadArtifact(401, 2)
const uploader = createUploader(true)
const result = await uploader.uploadArtifacts(artifacts, releaseId, url)
expect(result).toEqual({})
expect(uploadMock).toHaveBeenCalledTimes(2)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art1", releaseId)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art2", releaseId)
expect(deleteMock).toHaveBeenCalledTimes(0)
})
it("abort when upload failed with 5xx response after 3 attempts", async () => {
mockListWithoutAssets() mockListWithoutAssets()
mockUploadArtifact(500, 4) mockUploadArtifact(500, 4)
const uploader = createUploader(true) const uploader = createUploader(true)
const result = await uploader.uploadArtifacts(artifacts, releaseId, url) await uploader.uploadArtifacts(artifacts, releaseId, url)
expect(result).toEqual({}) expect(uploadMock).toBeCalledTimes(5)
expect(uploadMock).toHaveBeenCalledTimes(5) expect(uploadMock)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art1", releaseId) .toBeCalledWith(url, contentLength, 'raw', fileContents, 'art1', releaseId)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art1", releaseId) expect(uploadMock)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art1", releaseId) .toBeCalledWith(url, contentLength, 'raw', fileContents, 'art1', releaseId)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art2", releaseId) expect(uploadMock)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art2", releaseId) .toBeCalledWith(url, contentLength, 'raw', fileContents, 'art1', releaseId)
expect(uploadMock)
.toBeCalledWith(url, contentLength, 'raw', fileContents, 'art2', releaseId)
expect(uploadMock)
.toBeCalledWith(url, contentLength, 'raw', fileContents, 'art2', releaseId)
expect(deleteMock).toHaveBeenCalledTimes(0) expect(deleteMock).toBeCalledTimes(0)
}) })
it("replaces all artifacts", async () => { it('replaces all artifacts', async () => {
mockDeleteSuccess() mockDeleteSuccess()
mockListWithAssets() mockListWithAssets()
mockUploadSuccess() mockUploadArtifact()
const uploader = createUploader(true) const uploader = createUploader(true)
const result = await uploader.uploadArtifacts(artifacts, releaseId, url) await uploader.uploadArtifacts(artifacts, releaseId, url)
expect(result).toEqual({ expect(uploadMock).toBeCalledTimes(2)
"art1": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/art1", expect(uploadMock)
"art2": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/art2", .toBeCalledWith(url, contentLength, 'raw', fileContents, 'art1', releaseId)
}) expect(uploadMock)
expect(uploadMock).toHaveBeenCalledTimes(2) .toBeCalledWith(url, contentLength, 'raw', fileContents, 'art2', releaseId)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art1", releaseId)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art2", releaseId)
expect(deleteMock).toHaveBeenCalledTimes(2) expect(deleteMock).toBeCalledTimes(2)
expect(deleteMock).toHaveBeenCalledWith(1) expect(deleteMock).toBeCalledWith(1)
expect(deleteMock).toHaveBeenCalledWith(2) expect(deleteMock).toBeCalledWith(2)
}) })
it("replaces no artifacts when previous asset list empty", async () => { it('replaces no artifacts when previous asset list empty', async () => {
mockDeleteSuccess() mockDeleteSuccess()
mockListWithoutAssets() mockListWithoutAssets()
mockUploadSuccess() mockUploadArtifact()
const uploader = createUploader(true) const uploader = createUploader(true)
const result = await uploader.uploadArtifacts(artifacts, releaseId, url) await uploader.uploadArtifacts(artifacts, releaseId, url)
expect(result).toEqual({ expect(uploadMock).toBeCalledTimes(2)
"art1": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/art1", expect(uploadMock)
"art2": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/art2", .toBeCalledWith(url, contentLength, 'raw', fileContents, 'art1', releaseId)
}) expect(uploadMock)
expect(uploadMock).toHaveBeenCalledTimes(2) .toBeCalledWith(url, contentLength, 'raw', fileContents, 'art2', releaseId)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art1", releaseId)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art2", releaseId)
expect(deleteMock).toHaveBeenCalledTimes(0) expect(deleteMock).toBeCalledTimes(0)
}) })
it("retry when upload failed with 5xx response", async () => { it('retry when upload failed with 5xx response', async () => {
mockListWithoutAssets() mockListWithoutAssets()
mockUploadArtifact(500, 2) mockUploadArtifact(500, 2)
const uploader = createUploader(true) const uploader = createUploader(true)
const result = await uploader.uploadArtifacts(artifacts, releaseId, url) await uploader.uploadArtifacts(artifacts, releaseId, url)
expect(result).toEqual({}) expect(uploadMock).toBeCalledTimes(4)
expect(uploadMock).toHaveBeenCalledTimes(4) expect(uploadMock)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art1", releaseId) .toBeCalledWith(url, contentLength, 'raw', fileContents, 'art1', releaseId)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art1", releaseId) expect(uploadMock)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art1", releaseId) .toBeCalledWith(url, contentLength, 'raw', fileContents, 'art1', releaseId)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art2", releaseId) expect(uploadMock)
.toBeCalledWith(url, contentLength, 'raw', fileContents, 'art1', releaseId)
expect(uploadMock)
.toBeCalledWith(url, contentLength, 'raw', fileContents, 'art2', releaseId)
expect(deleteMock).toHaveBeenCalledTimes(0) expect(deleteMock).toBeCalledTimes(0)
}) })
it("throws upload error when replacesExistingArtifacts is true", async () => { it('throws upload error when replacesExistingArtifacts is true', async () => {
mockListWithoutAssets() mockListWithoutAssets()
mockUploadError() mockUploadError()
const uploader = createUploader(true, true) const uploader = createUploader(true, true)
@@ -178,10 +140,10 @@ describe("ArtifactUploader", () => {
} }
}) })
it("throws error from replace", async () => { it('throws error from replace', async () => {
mockDeleteError() mockDeleteError()
mockListWithAssets() mockListWithAssets()
mockUploadSuccess() mockUploadArtifact()
const uploader = createUploader(true) const uploader = createUploader(true)
expect.hasAssertions() expect.hasAssertions()
@@ -192,26 +154,24 @@ describe("ArtifactUploader", () => {
} }
}) })
it("updates all artifacts, delete none", async () => { it('updates all artifacts, delete none', async () => {
mockDeleteError() mockDeleteError()
mockListWithAssets() mockListWithAssets()
mockUploadSuccess() mockUploadArtifact()
const uploader = createUploader(false) const uploader = createUploader(false)
const result = await uploader.uploadArtifacts(artifacts, releaseId, url) await uploader.uploadArtifacts(artifacts, releaseId, url)
expect(result).toEqual({ expect(uploadMock).toBeCalledTimes(2)
"art1": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/art1", expect(uploadMock)
"art2": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/art2", .toBeCalledWith(url, contentLength, 'raw', fileContents, 'art1', releaseId)
}) expect(uploadMock)
expect(uploadMock).toHaveBeenCalledTimes(2) .toBeCalledWith(url, contentLength, 'raw', fileContents, 'art2', releaseId)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art1", releaseId)
expect(uploadMock).toHaveBeenCalledWith(url, contentLength, "raw", fakeReadStream, "art2", releaseId)
expect(deleteMock).toHaveBeenCalledTimes(0) expect(deleteMock).toBeCalledTimes(0)
}) })
function createUploader(replaces: boolean, throws = false): GithubArtifactUploader { function createUploader(replaces: boolean, throws: boolean = false): GithubArtifactUploader {
const MockReleases = jest.fn<Releases, any>(() => { const MockReleases = jest.fn<Releases, any>(() => {
return { return {
create: jest.fn(), create: jest.fn(),
@@ -220,8 +180,7 @@ describe("ArtifactUploader", () => {
listArtifactsForRelease: listArtifactsMock, listArtifactsForRelease: listArtifactsMock,
listReleases: jest.fn(), listReleases: jest.fn(),
update: jest.fn(), update: jest.fn(),
uploadArtifact: uploadMock, uploadArtifact: uploadMock
generateReleaseNotes: jest.fn(),
} }
}) })
return new GithubArtifactUploader(new MockReleases(), replaces, throws) return new GithubArtifactUploader(new MockReleases(), replaces, throws)
@@ -239,12 +198,12 @@ describe("ArtifactUploader", () => {
listArtifactsMock.mockResolvedValue([ listArtifactsMock.mockResolvedValue([
{ {
name: "art1", name: "art1",
id: 1, id: 1
}, },
{ {
name: "art2", name: "art2",
id: 2, id: 2
}, }
]) ])
} }
@@ -252,14 +211,10 @@ describe("ArtifactUploader", () => {
listArtifactsMock.mockResolvedValue([]) listArtifactsMock.mockResolvedValue([])
} }
function mockUploadSuccess() { function mockUploadArtifact(status: number = 200, failures: number = 0) {
uploadMock.mockImplementation((_, __, ___, ____, name) => Promise.resolve(mockUploadResponse(name)))
}
function mockUploadArtifact(status = 200, failures = 0) {
const error = new RequestError(`HTTP ${status}`, status, { const error = new RequestError(`HTTP ${status}`, status, {
headers: {}, headers: {},
request: { method: "GET", url: "", headers: {} }, request: {method: 'GET', url: '', headers: {}}
}) })
for (let index = 0; index < failures; index++) { for (let index = 0; index < failures; index++) {
uploadMock.mockRejectedValueOnce(error) uploadMock.mockRejectedValueOnce(error)
@@ -270,7 +225,7 @@ describe("ArtifactUploader", () => {
function mockUploadError() { function mockUploadError() {
uploadMock.mockRejectedValue({ uploadMock.mockRejectedValue({
message: "error", message: "error",
status: 502, status: 502
}) })
} }
}) });

View File

@@ -1,95 +1,68 @@
import { GithubError } from "../src/GithubError" import { GithubError } from "../src/GithubError"
describe("ErrorMessage", () => { describe('ErrorMessage', () => {
describe("has error with code", () => {
describe('has error with code', () => {
const error = { const error = {
message: "something bad happened", message: 'something bad happened',
errors: [ errors: [
{ {
code: "missing", code: 'missing',
resource: "release", resource: 'release'
}, },
{ {
code: "already_exists", code: 'already_exists',
resource: "release", resource: 'release'
}, }
], ],
status: 422, status: 422
} }
it("does not have error", () => { it('does not have error', () => {
const githubError = new GithubError(error) const githubError = new GithubError(error)
expect(githubError.hasErrorWithCode("missing_field")).toBeFalsy() expect(githubError.hasErrorWithCode('missing_field')).toBeFalsy()
}) })
it("has error", () => { it('has error', () => {
const githubError = new GithubError(error) const githubError = new GithubError(error)
expect(githubError.hasErrorWithCode("missing")).toBeTruthy() expect(githubError.hasErrorWithCode('missing')).toBeTruthy()
}) })
}) })
describe("has error with remediation", () => { it('generates message with errors', () => {
it("provides remediation with 404 without errors", () => {
const error = { status: 404, message: "message" }
const githubError = new GithubError(error)
expect(githubError.toString()).toBe(
"Error 404: message\nMake sure your github token has access to the repo and has permission to author releases"
)
})
it("provides remediation with 404 with errors", () => {
const error = {
message: "message",
errors: [
{
code: "missing",
resource: "release",
},
],
status: 404,
}
const githubError = new GithubError(error)
expect(githubError.toString()).toBe(
"Error 404: message\nErrors:\n- release does not exist.\nMake sure your github token has access to the repo and has permission to author releases"
)
})
})
it("generates message with errors", () => {
const error = { const error = {
message: "something bad happened", message: 'something bad happened',
errors: [ errors: [
{ {
code: "missing", code: 'missing',
resource: "release", resource: 'release'
}, },
{ {
code: "already_exists", code: 'already_exists',
resource: "release", resource: 'release'
}, }
], ],
status: 422, status: 422
} }
const githubError = new GithubError(error) const githubError = new GithubError(error)
const expectedString = const expectedString = "Error 422: something bad happened\nErrors:\n- release does not exist.\n- release already exists."
"Error 422: something bad happened\nErrors:\n- release does not exist.\n- release already exists."
expect(githubError.toString()).toBe(expectedString) expect(githubError.toString()).toBe(expectedString)
}) })
it("generates message without errors", () => { it('generates message without errors', () => {
const error = { const error = {
message: "something bad happened", message: 'something bad happened',
status: 422, status: 422
} }
const githubError = new GithubError(error) const githubError = new GithubError(error)
expect(githubError.toString()).toBe("Error 422: something bad happened") expect(githubError.toString()).toBe('Error 422: something bad happened')
}) })
it("provides error status", () => { it('provides error status', () => {
const error = { status: 404 } const error = { status: 404 }
const githubError = new GithubError(error) const githubError = new GithubError(error)
expect(githubError.status).toBe(404) expect(githubError.status).toBe(404)

View File

@@ -1,21 +1,22 @@
import { GithubErrorDetail } from "../src/GithubErrorDetail" import { GithubErrorDetail } from "../src/GithubErrorDetail"
describe("GithubErrorDetail", () => { describe('GithubErrorDetail', () => {
it("provides error code", () => {
it('provides error code', () => {
const error = { const error = {
code: "missing", code: "missing"
} }
const detail = new GithubErrorDetail(error) const detail = new GithubErrorDetail(error)
expect(detail.code).toBe("missing") expect(detail.code).toBe('missing')
}) })
it("generates missing resource error message", () => { it('generates missing resource error message', () => {
const resource = "release" const resource = "release"
const error = { const error = {
code: "missing", code: "missing",
resource: resource, resource: resource
} }
const detail = new GithubErrorDetail(error) const detail = new GithubErrorDetail(error)
@@ -24,13 +25,13 @@ describe("GithubErrorDetail", () => {
expect(message).toBe(`${resource} does not exist.`) expect(message).toBe(`${resource} does not exist.`)
}) })
it("generates missing field error message", () => { it('generates missing field error message', () => {
const resource = "release" const resource = "release"
const field = "body" const field = "body"
const error = { const error = {
code: "missing_field", code: "missing_field",
field: field, field: field,
resource: resource, resource: resource
} }
const detail = new GithubErrorDetail(error) const detail = new GithubErrorDetail(error)
@@ -39,13 +40,13 @@ describe("GithubErrorDetail", () => {
expect(message).toBe(`The ${field} field on ${resource} is missing.`) expect(message).toBe(`The ${field} field on ${resource} is missing.`)
}) })
it("generates invalid field error message", () => { it('generates invalid field error message', () => {
const resource = "release" const resource = "release"
const field = "body" const field = "body"
const error = { const error = {
code: "invalid", code: "invalid",
field: field, field: field,
resource: resource, resource: resource
} }
const detail = new GithubErrorDetail(error) const detail = new GithubErrorDetail(error)
@@ -54,11 +55,11 @@ describe("GithubErrorDetail", () => {
expect(message).toBe(`The ${field} field on ${resource} is an invalid format.`) expect(message).toBe(`The ${field} field on ${resource} is an invalid format.`)
}) })
it("generates resource already exists error message", () => { it('generates resource already exists error message', () => {
const resource = "release" const resource = "release"
const error = { const error = {
code: "already_exists", code: "already_exists",
resource: resource, resource: resource
} }
const detail = new GithubErrorDetail(error) const detail = new GithubErrorDetail(error)
@@ -67,13 +68,13 @@ describe("GithubErrorDetail", () => {
expect(message).toBe(`${resource} already exists.`) expect(message).toBe(`${resource} already exists.`)
}) })
describe("generates custom error message", () => { describe('generates custom error message', () => {
it("with documentation url", () => { it('with documentation url', () => {
const url = "https://api.example.com" const url = "https://api.example.com"
const error = { const error = {
code: "custom", code: "custom",
message: "foo", message: "foo",
documentation_url: url, documentation_url: url
} }
const detail = new GithubErrorDetail(error) const detail = new GithubErrorDetail(error)
@@ -82,16 +83,16 @@ describe("GithubErrorDetail", () => {
expect(message).toBe(`foo\nPlease see ${url}.`) expect(message).toBe(`foo\nPlease see ${url}.`)
}) })
it("without documentation url", () => { it('without documentation url', () => {
const error = { const error = {
code: "custom", code: "custom",
message: "foo", message: "foo"
} }
const detail = new GithubErrorDetail(error) const detail = new GithubErrorDetail(error)
const message = detail.toString() const message = detail.toString()
expect(message).toBe("foo") expect(message).toBe('foo')
}) })
}) })
}) })

View File

@@ -1,24 +1,27 @@
const mockGetInput = jest.fn() const mockGetInput = jest.fn();
const mockGetBooleanInput = jest.fn() const mockGetBooleanInput = jest.fn();
const mockGlob = jest.fn() const mockGlob = jest.fn()
const mockReadFileSync = jest.fn() const mockReadFileSync = jest.fn();
const mockStatSync = jest.fn() const mockStatSync = jest.fn();
import { Artifact } from "../src/Artifact" import {Artifact} from "../src/Artifact";
import { ArtifactGlobber } from "../src/ArtifactGlobber" import {ArtifactGlobber} from "../src/ArtifactGlobber";
import { Context } from "@actions/github/lib/context" import {Context} from "@actions/github/lib/context";
import { Inputs, CoreInputs } from "../src/Inputs" import {Inputs, CoreInputs} from "../src/Inputs";
const artifacts = [new Artifact("a/art1"), new Artifact("b/art2")] const artifacts = [
new Artifact('a/art1'),
new Artifact('b/art2')
]
jest.mock("@actions/core", () => { jest.mock('@actions/core', () => {
return { return {
getInput: mockGetInput, getInput: mockGetInput,
getBooleanInput: mockGetBooleanInput, getBooleanInput: mockGetBooleanInput
} };
}) })
jest.mock("fs", () => { jest.mock('fs', () => {
// existsSync is used by Context's constructor // existsSync is used by Context's constructor
// noinspection JSUnusedGlobalSymbols // noinspection JSUnusedGlobalSymbols
return { return {
@@ -26,416 +29,438 @@ jest.mock("fs", () => {
return false return false
}, },
readFileSync: mockReadFileSync, readFileSync: mockReadFileSync,
statSync: mockStatSync, statSync: mockStatSync
} };
}) })
describe("Inputs", () => { describe('Inputs', () => {
let context: Context let context: Context;
let inputs: Inputs let inputs: Inputs;
beforeEach(() => { beforeEach(() => {
mockGetInput.mockReset() mockGetInput.mockReset()
context = new Context() context = new Context()
inputs = new CoreInputs(createGlobber(), context) inputs = new CoreInputs(createGlobber(), context)
}) })
describe("commit", () => { describe('commit', () => {
it("returns commit", () => { it('returns commit', () => {
mockGetInput.mockReturnValueOnce("commit") mockGetInput.mockReturnValueOnce('commit')
expect(inputs.commit).toBe("commit") expect(inputs.commit).toBe('commit')
}) })
it("returns undefined when omitted", () => { it('returns undefined when omitted', () => {
mockGetInput.mockReturnValueOnce("") mockGetInput.mockReturnValueOnce('')
expect(inputs.commit).toBeUndefined() expect(inputs.commit).toBeUndefined()
}) })
}) })
it("returns token", () => { it('returns token', () => {
mockGetInput.mockReturnValue("42") mockGetInput.mockReturnValue('42')
expect(inputs.token).toBe("42") expect(inputs.token).toBe('42')
}) })
describe("allowsUpdates", () => { describe('allowsUpdates', () => {
it("returns false", () => { it('returns false', () => {
expect(inputs.allowUpdates).toBe(false) expect(inputs.allowUpdates).toBe(false)
}) })
it("returns true", () => { it('returns true', () => {
mockGetInput.mockReturnValue("true") mockGetInput.mockReturnValue('true')
expect(inputs.allowUpdates).toBe(true) expect(inputs.allowUpdates).toBe(true)
}) })
}) })
describe("artifactErrorsFailBuild", () => { describe('artifactErrorsFailBuild', () => {
it("returns false", () => { it('returns false', () => {
expect(inputs.artifactErrorsFailBuild).toBe(false) expect(inputs.artifactErrorsFailBuild).toBe(false)
}) })
it("returns true", () => { it('returns true', () => {
mockGetInput.mockReturnValue("true") mockGetInput.mockReturnValue('true')
expect(inputs.artifactErrorsFailBuild).toBe(true) expect(inputs.artifactErrorsFailBuild).toBe(true)
}) })
}) })
describe("artifacts", () => { describe('artifacts', () => {
it("globber told to throw errors", () => { it('globber told to throw errors', () => {
mockGetInput.mockReturnValueOnce("art1").mockReturnValueOnce("contentType").mockReturnValueOnce("true") mockGetInput.mockReturnValueOnce('art1')
.mockReturnValueOnce('contentType')
.mockReturnValueOnce('true')
expect(inputs.artifacts).toEqual(artifacts) expect(inputs.artifacts).toEqual(artifacts)
expect(mockGlob).toHaveBeenCalledTimes(1) expect(mockGlob).toBeCalledTimes(1)
expect(mockGlob).toHaveBeenCalledWith("art1", "contentType", true) expect(mockGlob).toBeCalledWith('art1', 'contentType', true)
}) })
it("returns empty artifacts", () => { it('returns empty artifacts', () => {
mockGetInput.mockReturnValueOnce("").mockReturnValueOnce("") mockGetInput.mockReturnValueOnce('')
.mockReturnValueOnce('')
expect(inputs.artifacts).toEqual([]) expect(inputs.artifacts).toEqual([])
expect(mockGlob).toHaveBeenCalledTimes(0) expect(mockGlob).toBeCalledTimes(0)
}) })
it("returns input.artifacts", () => { it('returns input.artifacts', () => {
mockGetInput.mockReturnValueOnce("art1").mockReturnValueOnce("contentType").mockReturnValueOnce("false") mockGetInput.mockReturnValueOnce('art1')
.mockReturnValueOnce('contentType')
.mockReturnValueOnce('false')
expect(inputs.artifacts).toEqual(artifacts) expect(inputs.artifacts).toEqual(artifacts)
expect(mockGlob).toHaveBeenCalledTimes(1) expect(mockGlob).toBeCalledTimes(1)
expect(mockGlob).toHaveBeenCalledWith("art1", "contentType", false) expect(mockGlob).toBeCalledWith('art1', 'contentType', false)
}) })
it("returns input.artifacts with default contentType", () => { it('returns input.artifacts with default contentType', () => {
mockGetInput.mockReturnValueOnce("art1").mockReturnValueOnce("").mockReturnValueOnce("false") mockGetInput.mockReturnValueOnce('art1')
.mockReturnValueOnce('')
.mockReturnValueOnce('false')
expect(inputs.artifacts).toEqual(artifacts) expect(inputs.artifacts).toEqual(artifacts)
expect(mockGlob).toHaveBeenCalledTimes(1) expect(mockGlob).toBeCalledTimes(1)
expect(mockGlob).toHaveBeenCalledWith("art1", "raw", false) expect(mockGlob).toBeCalledWith('art1', 'raw', false)
}) })
it("returns input.artifact", () => { it('returns input.artifact', () => {
mockGetInput mockGetInput.mockReturnValueOnce('')
.mockReturnValueOnce("") .mockReturnValueOnce('art2')
.mockReturnValueOnce("art2") .mockReturnValueOnce('contentType')
.mockReturnValueOnce("contentType") .mockReturnValueOnce('false')
.mockReturnValueOnce("false")
expect(inputs.artifacts).toEqual(artifacts) expect(inputs.artifacts).toEqual(artifacts)
expect(mockGlob).toHaveBeenCalledTimes(1) expect(mockGlob).toBeCalledTimes(1)
expect(mockGlob).toHaveBeenCalledWith("art2", "contentType", false) expect(mockGlob).toBeCalledWith('art2', 'contentType', false)
}) })
}) })
describe("createdDraft", () => { describe('createdDraft', () => {
it("returns false", () => { it('returns false', () => {
expect(inputs.createdDraft).toBe(false) expect(inputs.createdDraft).toBe(false)
}) })
it("returns true", () => { it('returns true', () => {
mockGetInput.mockReturnValue("true") mockGetInput.mockReturnValue('true')
expect(inputs.createdDraft).toBe(true) expect(inputs.createdDraft).toBe(true)
}) })
}) })
describe("createdReleaseBody", () => { describe('createdReleaseBody', () => {
it("returns input body", () => { it('returns input body', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("body") mockGetInput
expect(inputs.createdReleaseBody).toBe("body") .mockReturnValueOnce('false')
.mockReturnValueOnce('body')
expect(inputs.createdReleaseBody).toBe('body')
}) })
it("returns body file contents", () => { it('returns body file contents', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("").mockReturnValueOnce("a/path") mockGetInput
mockReadFileSync.mockReturnValue("file") .mockReturnValueOnce('false')
.mockReturnValueOnce('')
.mockReturnValueOnce('a/path')
mockReadFileSync.mockReturnValue('file')
expect(inputs.createdReleaseBody).toBe("file") expect(inputs.createdReleaseBody).toBe('file')
}) })
it("returns empty", () => { it('returns empty', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("").mockReturnValueOnce("") mockGetInput
expect(inputs.createdReleaseBody).toBe("") .mockReturnValueOnce('false')
.mockReturnValueOnce('')
.mockReturnValueOnce('')
expect(inputs.createdReleaseBody).toBe('')
}) })
it("returns undefined when omitted", () => { it('returns undefined when omitted', () => {
mockGetInput.mockReturnValueOnce("true").mockReturnValueOnce("body") mockGetInput
.mockReturnValueOnce('true')
.mockReturnValueOnce('body')
expect(inputs.createdReleaseBody).toBeUndefined() expect(inputs.createdReleaseBody).toBeUndefined()
}) })
}) })
describe("createdReleaseName", () => { describe('createdReleaseName', () => {
it("returns input name", () => { it('returns input name', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("name") mockGetInput
expect(inputs.createdReleaseName).toBe("name") .mockReturnValueOnce('false')
.mockReturnValueOnce('name')
expect(inputs.createdReleaseName).toBe('name')
}) })
it("returns undefined when omitted", () => { it('returns undefined when omitted', () => {
mockGetInput.mockReturnValueOnce("true").mockReturnValueOnce("name") mockGetInput
.mockReturnValueOnce('true')
.mockReturnValueOnce('name')
expect(inputs.createdReleaseName).toBeUndefined() expect(inputs.createdReleaseName).toBeUndefined()
}) })
it("returns tag", () => { it('returns tag', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("") mockGetInput
context.ref = "refs/tags/sha-tag" .mockReturnValueOnce('false')
expect(inputs.createdReleaseName).toBe("sha-tag") .mockReturnValueOnce('')
context.ref = 'refs/tags/sha-tag'
expect(inputs.createdReleaseName).toBe('sha-tag')
}) })
}) })
describe("discussionCategory", () => { describe('discussionCategory', () => {
it("returns category", () => { it('returns category', () => {
mockGetInput.mockReturnValue("Release") mockGetInput.mockReturnValue('Release')
expect(inputs.discussionCategory).toBe("Release") expect(inputs.discussionCategory).toBe('Release')
}) })
it("returns undefined", () => { it('returns undefined', () => {
mockGetInput.mockReturnValue("") mockGetInput.mockReturnValue('')
expect(inputs.discussionCategory).toBe(undefined) expect(inputs.discussionCategory).toBe(undefined)
}) })
}) })
describe("generateReleaseNotes", () => { describe('generateReleaseNotes', () => {
it("returns returns true", function () { it('returns returns true', function () {
mockGetInput.mockReturnValue("true") mockGetInput.mockReturnValue("true")
expect(inputs.generateReleaseNotes).toBe(true) expect(inputs.generateReleaseNotes).toBe(true)
}) });
it("returns false when omitted", function () { it('returns false when omitted', function () {
mockGetInput.mockReturnValue("") mockGetInput.mockReturnValue("")
expect(inputs.generateReleaseNotes).toBe(false) expect(inputs.generateReleaseNotes).toBe(false)
}) });
}) })
describe("makeLatest", () => { describe('owner', () => {
it("returns legacy", () => { it('returns owner from context', function () {
mockGetInput.mockReturnValueOnce("legacy")
expect(inputs.makeLatest).toBe("legacy")
})
it("returns false", () => {
mockGetInput.mockReturnValueOnce("false")
expect(inputs.makeLatest).toBe("false")
})
it("returns true", () => {
mockGetInput.mockReturnValueOnce("true")
expect(inputs.makeLatest).toBe("true")
})
it("returns undefined", () => {
mockGetInput.mockReturnValueOnce("something_else")
expect(inputs.makeLatest).toBe(undefined)
})
})
describe("owner", () => {
it("returns owner from context", function () {
process.env.GITHUB_REPOSITORY = "owner/repo" process.env.GITHUB_REPOSITORY = "owner/repo"
mockGetInput.mockReturnValue("") mockGetInput.mockReturnValue("")
expect(inputs.owner).toBe("owner") expect(inputs.owner).toBe("owner")
}) });
it("returns owner from inputs", function () { it('returns owner from inputs', function () {
mockGetInput.mockReturnValue("owner") mockGetInput.mockReturnValue("owner")
expect(inputs.owner).toBe("owner") expect(inputs.owner).toBe("owner")
}) });
}) })
describe("createdPrerelase", () => { describe('createdPrerelase', () => {
it("returns false", () => { it('returns false', () => {
expect(inputs.createdPrerelease).toBe(false) expect(inputs.createdPrerelease).toBe(false)
}) })
it("returns true", () => { it('returns true', () => {
mockGetInput.mockReturnValue("true") mockGetInput.mockReturnValue('true')
expect(inputs.createdPrerelease).toBe(true) expect(inputs.createdPrerelease).toBe(true)
}) })
}) })
describe("replacesArtifacts", () => { describe('replacesArtifacts', () => {
it("returns false", () => { it('returns false', () => {
expect(inputs.replacesArtifacts).toBe(false) expect(inputs.replacesArtifacts).toBe(false)
}) })
it("returns true", () => { it('returns true', () => {
mockGetInput.mockReturnValue("true") mockGetInput.mockReturnValue('true')
expect(inputs.replacesArtifacts).toBe(true) expect(inputs.replacesArtifacts).toBe(true)
}) })
}) })
describe("removeArtifacts", () => { describe('removeArtifacts', () => {
it("returns false", () => { it('returns false', () => {
expect(inputs.removeArtifacts).toBe(false) expect(inputs.removeArtifacts).toBe(false)
}) })
it("returns true", () => { it('returns true', () => {
mockGetInput.mockReturnValue("true") mockGetInput.mockReturnValue('true')
expect(inputs.removeArtifacts).toBe(true) expect(inputs.removeArtifacts).toBe(true)
}) })
}) })
describe("repo", () => { describe('repo', () => {
it("returns repo from context", function () { it('returns repo from context', function () {
process.env.GITHUB_REPOSITORY = "owner/repo" process.env.GITHUB_REPOSITORY = "owner/repo"
mockGetInput.mockReturnValue("") mockGetInput.mockReturnValue("")
expect(inputs.repo).toBe("repo") expect(inputs.repo).toBe("repo")
}) });
it("returns repo from inputs", function () { it('returns repo from inputs', function () {
mockGetInput.mockReturnValue("repo") mockGetInput.mockReturnValue("repo")
expect(inputs.repo).toBe("repo") expect(inputs.repo).toBe("repo")
}) });
}) })
describe("skipIfReleaseExists", () => { describe('skipIfReleaseExists', () => {
it("returns false", () => { it('returns false', () => {
mockGetBooleanInput.mockReturnValue(false) mockGetBooleanInput.mockReturnValue(false)
expect(inputs.skipIfReleaseExists).toBe(false) expect(inputs.skipIfReleaseExists).toBe(false)
}) })
it("returns true", () => { it('returns true', () => {
mockGetBooleanInput.mockReturnValue(true) mockGetBooleanInput.mockReturnValue(true)
expect(inputs.skipIfReleaseExists).toBe(true) expect(inputs.skipIfReleaseExists).toBe(true)
}) })
}) })
describe("tag", () => { describe('tag', () => {
it("returns input tag", () => { it('returns input tag', () => {
mockGetInput.mockReturnValue("tag") mockGetInput.mockReturnValue('tag')
expect(inputs.tag).toBe("tag") expect(inputs.tag).toBe('tag')
}) })
it("returns context sha when input is empty", () => { it('returns context sha when input is empty', () => {
mockGetInput.mockReturnValue("") mockGetInput.mockReturnValue('')
context.ref = "refs/tags/sha-tag" context.ref = 'refs/tags/sha-tag'
expect(inputs.tag).toBe("sha-tag") expect(inputs.tag).toBe('sha-tag')
}) })
it("returns context sha when input is null", () => { it('returns context sha when input is null', () => {
mockGetInput.mockReturnValue(null) mockGetInput.mockReturnValue(null)
context.ref = "refs/tags/sha-tag" context.ref = 'refs/tags/sha-tag'
expect(inputs.tag).toBe("sha-tag") expect(inputs.tag).toBe('sha-tag')
}) })
it("throws if no tag", () => { it('throws if no tag', () => {
context.ref = "" context.ref = ""
expect(() => inputs.tag).toThrow() expect(() => inputs.tag).toThrow()
}) })
}) })
describe("updatedDraft", () => { describe('updatedDraft', () => {
it("returns false", () => { it('returns false', () => {
expect(inputs.updatedDraft).toBe(false) expect(inputs.updatedDraft).toBe(false)
}) })
it("returns true", () => { it('returns true', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValue("true") mockGetInput
.mockReturnValueOnce('false')
.mockReturnValue('true')
expect(inputs.updatedDraft).toBe(true) expect(inputs.updatedDraft).toBe(true)
}) })
it("returns true when omitted is blank", () => { it('returns true when omitted is blank', () => {
mockGetInput.mockReturnValueOnce("").mockReturnValue("true") mockGetInput
.mockReturnValueOnce('')
.mockReturnValue('true')
expect(inputs.updatedDraft).toBe(true) expect(inputs.updatedDraft).toBe(true)
}) })
it("returns undefined when omitted for update", () => { it('returns undefined when omitted for update', () => {
mockGetInput.mockReturnValueOnce("true").mockReturnValueOnce("true") mockGetInput
.mockReturnValueOnce('true')
.mockReturnValueOnce('true')
expect(inputs.updatedDraft).toBeUndefined() expect(inputs.updatedDraft).toBeUndefined()
}) })
}) })
describe("updatedReleaseBody", () => { describe('updatedReleaseBody', () => {
it("returns input body", () => { it('returns input body', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("false").mockReturnValueOnce("body")
expect(inputs.updatedReleaseBody).toBe("body")
})
it("returns body file contents", () => {
mockGetInput mockGetInput
.mockReturnValueOnce("false") .mockReturnValueOnce('false')
.mockReturnValueOnce("false") .mockReturnValueOnce('false')
.mockReturnValueOnce("") .mockReturnValueOnce('body')
.mockReturnValueOnce("a/path") expect(inputs.updatedReleaseBody).toBe('body')
mockReadFileSync.mockReturnValue("file")
expect(inputs.updatedReleaseBody).toBe("file")
}) })
it("returns empty", () => { it('returns body file contents', () => {
mockGetInput mockGetInput
.mockReturnValueOnce("false") .mockReturnValueOnce('false')
.mockReturnValueOnce("false") .mockReturnValueOnce('false')
.mockReturnValueOnce("") .mockReturnValueOnce('')
.mockReturnValueOnce("") .mockReturnValueOnce('a/path')
expect(inputs.updatedReleaseBody).toBe("") mockReadFileSync.mockReturnValue('file')
expect(inputs.updatedReleaseBody).toBe('file')
}) })
it("returns undefined when omitted", () => { it('returns empty', () => {
mockGetInput.mockReturnValueOnce("true").mockReturnValueOnce("false").mockReturnValueOnce("body") mockGetInput
.mockReturnValueOnce('false')
.mockReturnValueOnce('false')
.mockReturnValueOnce('')
.mockReturnValueOnce('')
expect(inputs.updatedReleaseBody).toBe('')
})
it('returns undefined when omitted', () => {
mockGetInput
.mockReturnValueOnce('true')
.mockReturnValueOnce('false')
.mockReturnValueOnce('body')
expect(inputs.updatedReleaseBody).toBeUndefined() expect(inputs.updatedReleaseBody).toBeUndefined()
}) })
it("returns undefined when omitted for update", () => { it('returns undefined when omitted for update', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("true").mockReturnValueOnce("body") mockGetInput
.mockReturnValueOnce('false')
.mockReturnValueOnce('true')
.mockReturnValueOnce('body')
expect(inputs.updatedReleaseBody).toBeUndefined() expect(inputs.updatedReleaseBody).toBeUndefined()
}) })
}) })
describe("updatedReleaseName", () => { describe('updatedReleaseName', () => {
it("returns input name", () => { it('returns input name', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("false").mockReturnValueOnce("name") mockGetInput
expect(inputs.updatedReleaseName).toBe("name") .mockReturnValueOnce('false')
.mockReturnValueOnce('false')
.mockReturnValueOnce('name')
expect(inputs.updatedReleaseName).toBe('name')
}) })
it("returns undefined when omitted", () => { it('returns undefined when omitted', () => {
mockGetInput.mockReturnValueOnce("true").mockReturnValueOnce("false").mockReturnValueOnce("name") mockGetInput
.mockReturnValueOnce('true')
.mockReturnValueOnce('false')
.mockReturnValueOnce('name')
expect(inputs.updatedReleaseName).toBeUndefined() expect(inputs.updatedReleaseName).toBeUndefined()
}) })
it("returns undefined when omitted for update", () => { it('returns undefined when omitted for update', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("true").mockReturnValueOnce("name") mockGetInput
.mockReturnValueOnce('false')
.mockReturnValueOnce('true')
.mockReturnValueOnce('name')
expect(inputs.updatedReleaseName).toBeUndefined() expect(inputs.updatedReleaseName).toBeUndefined()
}) })
it("returns tag", () => { it('returns tag', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("false").mockReturnValueOnce("") mockGetInput
context.ref = "refs/tags/sha-tag" .mockReturnValueOnce('false')
expect(inputs.updatedReleaseName).toBe("sha-tag") .mockReturnValueOnce('false')
.mockReturnValueOnce('')
context.ref = 'refs/tags/sha-tag'
expect(inputs.updatedReleaseName).toBe('sha-tag')
}) })
}) })
describe("updatedPrerelease", () => { describe('updatedPrerelease', () => {
it("returns false", () => { it('returns false', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("false") mockGetInput
.mockReturnValueOnce('false')
.mockReturnValueOnce('false')
expect(inputs.updatedPrerelease).toBe(false) expect(inputs.updatedPrerelease).toBe(false)
}) })
it("returns true", () => { it('returns true', () => {
mockGetInput.mockReturnValueOnce("false").mockReturnValueOnce("true") mockGetInput
.mockReturnValueOnce('false')
.mockReturnValueOnce('true')
expect(inputs.updatedPrerelease).toBe(true) expect(inputs.updatedPrerelease).toBe(true)
}) })
it("returns undefined when omitted for update", () => { it('returns undefined when omitted for update', () => {
mockGetInput.mockReturnValueOnce("true").mockReturnValueOnce("false") mockGetInput
.mockReturnValueOnce('true')
.mockReturnValueOnce('false')
expect(inputs.updatedPrerelease).toBeUndefined() expect(inputs.updatedPrerelease).toBeUndefined()
}) })
}) })
describe("updateOnlyUnreleased", () => { describe('updateOnlyUnreleased', () => {
it("returns false", () => { it('returns false', () => {
expect(inputs.updateOnlyUnreleased).toBe(false) expect(inputs.updateOnlyUnreleased).toBe(false)
}) })
it("returns true", () => { it('returns true', () => {
mockGetInput.mockReturnValueOnce("true") mockGetInput.mockReturnValueOnce('true')
expect(inputs.updateOnlyUnreleased).toBe(true) expect(inputs.updateOnlyUnreleased).toBe(true)
}) })
}) })
describe("omitBodyDuringUpdate", () => {
it("returns false", () => {
expect(inputs.omitBodyDuringUpdate).toBe(false)
})
it("returns true", () => {
mockGetInput.mockReturnValueOnce("true")
expect(inputs.omitBodyDuringUpdate).toBe(true)
})
})
function createGlobber(): ArtifactGlobber { function createGlobber(): ArtifactGlobber {
const MockGlobber = jest.fn<ArtifactGlobber, any>(() => { const MockGlobber = jest.fn<ArtifactGlobber, any>(() => {
return { return {
globArtifactString: mockGlob, globArtifactString: mockGlob
} }
}) })
mockGlob.mockImplementation(() => artifacts) mockGlob.mockImplementation(() => artifacts)

View File

@@ -1,18 +1,18 @@
import { Action } from "../src/Action" import {Action} from "../src/Action";
import * as github from "@actions/github" import * as github from "@actions/github";
import { Inputs } from "../src/Inputs" import {Inputs} from "../src/Inputs";
import { GithubReleases, ReleaseData } from "../src/Releases" import {GithubReleases, ReleaseData} from "../src/Releases";
import { GithubArtifactUploader } from "../src/ArtifactUploader" import {GithubArtifactUploader} from "../src/ArtifactUploader";
import * as path from "path" import * as path from "path";
import { FileArtifactGlobber } from "../src/ArtifactGlobber" import {FileArtifactGlobber} from "../src/ArtifactGlobber";
import { Outputs } from "../src/Outputs" import {Outputs} from "../src/Outputs";
import { GithubArtifactDestroyer } from "../src/ArtifactDestroyer" import {GithubArtifactDestroyer} from "../src/ArtifactDestroyer";
import { ReleaseActionSkipper } from "../src/ActionSkipper" import {ReleaseActionSkipper} from "../src/ActionSkipper";
// This test is currently intended to be manually run during development. To run: // This test is currently intended to be manually run during development. To run:
// - Make sure you have an environment variable named GITHUB_TOKEN assigned to your token // - Make sure you have an environment variable named GITHUB_TOKEN assigned to your token
// - Remove skip from the test below // - Remove skip from the test below
describe.skip("Integration Test", () => { describe.skip('Integration Test', () => {
let action: Action let action: Action
beforeEach(() => { beforeEach(() => {
@@ -22,14 +22,18 @@ describe.skip("Integration Test", () => {
const inputs = getInputs() const inputs = getInputs()
const outputs = getOutputs() const outputs = getOutputs()
const releases = new GithubReleases(inputs, git) const releases = new GithubReleases(inputs, git)
const uploader = new GithubArtifactUploader(releases, inputs.replacesArtifacts, inputs.artifactErrorsFailBuild) const uploader = new GithubArtifactUploader(
releases,
inputs.replacesArtifacts,
inputs.artifactErrorsFailBuild,
)
const artifactDestroyer = new GithubArtifactDestroyer(releases) const artifactDestroyer = new GithubArtifactDestroyer(releases)
const actionSkipper = new ReleaseActionSkipper(inputs.skipIfReleaseExists, releases, inputs.tag) const actionSkipper = new ReleaseActionSkipper(inputs.skipIfReleaseExists, releases, inputs.tag)
action = new Action(inputs, outputs, releases, uploader, artifactDestroyer, actionSkipper) action = new Action(inputs, outputs, releases, uploader, artifactDestroyer, actionSkipper)
}) })
it("Performs action", async () => { it('Performs action', async () => {
await action.perform() await action.perform()
}) })
@@ -43,9 +47,8 @@ describe.skip("Integration Test", () => {
createdReleaseBody: "This release was generated by release-action's integration test", createdReleaseBody: "This release was generated by release-action's integration test",
createdReleaseName: "Releases Action Integration Test", createdReleaseName: "Releases Action Integration Test",
commit: undefined, commit: undefined,
discussionCategory: "Release", discussionCategory: 'Release',
generateReleaseNotes: true, generateReleaseNotes: true,
omitBodyDuringUpdate: false,
owner: "ncipollo", owner: "ncipollo",
createdPrerelease: false, createdPrerelease: false,
replacesArtifacts: true, replacesArtifacts: true,
@@ -58,10 +61,10 @@ describe.skip("Integration Test", () => {
updatedReleaseBody: "This release was updated by release-action's integration test", updatedReleaseBody: "This release was updated by release-action's integration test",
updatedReleaseName: "Releases Action Integration Test", updatedReleaseName: "Releases Action Integration Test",
updatedPrerelease: false, updatedPrerelease: false,
updateOnlyUnreleased: false, updateOnlyUnreleased: false
} }
}) })
return new MockInputs() return new MockInputs();
} }
function getOutputs(): Outputs { function getOutputs(): Outputs {
@@ -69,10 +72,7 @@ describe.skip("Integration Test", () => {
return { return {
applyReleaseData(releaseData: ReleaseData) { applyReleaseData(releaseData: ReleaseData) {
console.log(`Release Data: ${releaseData}`) console.log(`Release Data: ${releaseData}`)
}, }
applyAssetUrls(assetUrls: Record<string, string>) {
console.log(`Asset URLs: ${JSON.stringify(assetUrls)}`)
},
} }
}) })
return new MockOutputs() return new MockOutputs()
@@ -80,7 +80,7 @@ describe.skip("Integration Test", () => {
function artifacts() { function artifacts() {
const globber = new FileArtifactGlobber() const globber = new FileArtifactGlobber()
const artifactPath = path.join(__dirname, "Integration.test.ts") const artifactPath = path.join(__dirname, 'Integration.test.ts')
const artifactString = `~/Desktop,~/Desktop/test.txt,blarg.tx, ${artifactPath}` const artifactString = `~/Desktop,~/Desktop/test.txt,blarg.tx, ${artifactPath}`
return globber.globArtifactString(artifactString, "raw", false) return globber.globArtifactString(artifactString, "raw", false)
} }
@@ -88,4 +88,5 @@ describe.skip("Integration Test", () => {
function getToken(): string { function getToken(): string {
return process.env.GITHUB_TOKEN ?? "" return process.env.GITHUB_TOKEN ?? ""
} }
}) })

View File

@@ -1,63 +1,29 @@
import { CoreOutputs, type Outputs } from "../src/Outputs" const mockSetOutput = jest.fn();
import type { ReleaseData } from "../src/Releases"
jest.mock("@actions/core") import {CoreOutputs, Outputs} from "../src/Outputs";
const { setOutput: mockSetOutput } = jest.mocked(require("@actions/core")) import {ReleaseData} from "../src/Releases";
const TEST_URLS = { jest.mock('@actions/core', () => {
HTML_URL: "https://api.example.com/assets", return {setOutput: mockSetOutput};
UPLOAD_URL: "https://api.example.com", })
TARBALL_URL: "https://api.example.com/tarball",
ZIPBALL_URL: "https://api.example.com/zipball",
} as const
describe("Outputs", () => { describe('Outputs', () => {
let outputs: Outputs let outputs: Outputs;
let releaseData: ReleaseData let releaseData: ReleaseData
beforeEach(() => { beforeEach(() => {
outputs = new CoreOutputs() outputs = new CoreOutputs()
releaseData = { releaseData = {
id: 1, id: 1,
html_url: TEST_URLS.HTML_URL, html_url: 'https://api.example.com/assets',
upload_url: TEST_URLS.UPLOAD_URL, upload_url: 'https://api.example.com'
tarball_url: TEST_URLS.TARBALL_URL,
zipball_url: TEST_URLS.ZIPBALL_URL,
} }
}) })
it("Applies the release data to the action output", () => { it('Applies the release data to the action output', () => {
outputs.applyReleaseData(releaseData) outputs.applyReleaseData(releaseData)
expect(mockSetOutput).toHaveBeenCalledWith("id", releaseData.id) expect(mockSetOutput).toBeCalledWith('id', releaseData.id)
expect(mockSetOutput).toHaveBeenCalledWith("html_url", releaseData.html_url) expect(mockSetOutput).toBeCalledWith('html_url', releaseData.html_url)
expect(mockSetOutput).toHaveBeenCalledWith("upload_url", releaseData.upload_url) expect(mockSetOutput).toBeCalledWith('upload_url', releaseData.upload_url)
expect(mockSetOutput).toHaveBeenCalledWith("tarball_url", releaseData.tarball_url)
expect(mockSetOutput).toHaveBeenCalledWith("zipball_url", releaseData.zipball_url)
})
it("Handles null tarball_url and zipball_url", () => {
const releaseDataWithNulls = {
...releaseData,
tarball_url: null,
zipball_url: null,
}
outputs.applyReleaseData(releaseDataWithNulls)
expect(mockSetOutput).toHaveBeenCalledWith("tarball_url", "")
expect(mockSetOutput).toHaveBeenCalledWith("zipball_url", "")
})
it("Applies asset URLs to the action output", () => {
const assetUrls = {
"example.zip": "https://github.com/owner/repo/releases/download/v1.0.0/example.zip",
"example.tar.gz": "https://github.com/owner/repo/releases/download/v1.0.0/example.tar.gz",
}
outputs.applyAssetUrls(assetUrls)
expect(mockSetOutput).toHaveBeenCalledWith("assets", JSON.stringify(assetUrls))
})
it("Applies empty asset URLs to the action output", () => {
const assetUrls = {}
outputs.applyAssetUrls(assetUrls)
expect(mockSetOutput).toHaveBeenCalledWith("assets", JSON.stringify(assetUrls))
}) })
}) })

View File

@@ -1,13 +1,13 @@
import { ReleaseValidator } from "../src/ReleaseValidator" import {ReleaseValidator} from "../src/ReleaseValidator";
describe("validateReleaseUpdate", () => { describe("validateReleaseUpdate", () => {
describe("updateOnlyUnreleased is disabled", () => { describe("updateOnlyUnreleased is disabled", () => {
const validator = new ReleaseValidator(false) const validator = new ReleaseValidator(false)
it("should not throw", () => { it('should not throw', () => {
const releaseResponse = { const releaseResponse = {
draft: false, draft: false,
prerelease: false, prerelease: false,
name: "Name", name: "Name"
} }
expect(() => { expect(() => {
validator.validateReleaseUpdate(releaseResponse) validator.validateReleaseUpdate(releaseResponse)
@@ -16,59 +16,59 @@ describe("validateReleaseUpdate", () => {
}) })
describe("updateOnlyUnreleased is enabled", () => { describe("updateOnlyUnreleased is enabled", () => {
const validator = new ReleaseValidator(true) const validator = new ReleaseValidator(true)
it("should throw if neither draft or prerelease are enabled", () => { it('should throw if neither draft or prerelease are enabled', () => {
const releaseResponse = { const releaseResponse = {
draft: false, draft: false,
prerelease: false, prerelease: false,
name: "Name", name: "Name"
} }
expect(() => { expect(() => {
validator.validateReleaseUpdate(releaseResponse) validator.validateReleaseUpdate(releaseResponse)
}).toThrow() }).toThrow()
}) })
it("should not throw if draft is enabled", () => { it('should not throw if draft is enabled', () => {
const releaseResponse = { const releaseResponse = {
draft: true, draft: true,
prerelease: false, prerelease: false,
name: "Name", name: "Name"
} }
expect(() => { expect(() => {
validator.validateReleaseUpdate(releaseResponse) validator.validateReleaseUpdate(releaseResponse)
}).not.toThrow() }).not.toThrow()
}) })
it("should not throw if prerelease is enabled", () => { it('should not throw if prerelease is enabled', () => {
const releaseResponse = { const releaseResponse = {
draft: false, draft: false,
prerelease: true, prerelease: true,
name: "Name", name: "Name"
} }
expect(() => { expect(() => {
validator.validateReleaseUpdate(releaseResponse) validator.validateReleaseUpdate(releaseResponse)
}).not.toThrow() }).not.toThrow()
}) })
it("should not throw if draft & prerelease is enabled", () => { it('should not throw if draft & prerelease is enabled', () => {
const releaseResponse = { const releaseResponse = {
draft: true, draft: true,
prerelease: true, prerelease: true,
name: "Name", name: "Name"
} }
expect(() => { expect(() => {
validator.validateReleaseUpdate(releaseResponse) validator.validateReleaseUpdate(releaseResponse)
}).not.toThrow() }).not.toThrow()
}) })
it("should default error message release name to release", () => { it('should default error message release name to release', () => {
const releaseResponse = { const releaseResponse = {
draft: false, draft: false,
prerelease: false, prerelease: false,
name: null, name: null
} }
expect(() => { expect(() => {
validator.validateReleaseUpdate(releaseResponse) validator.validateReleaseUpdate(releaseResponse)
}).toThrow(`Tried to update "release" which is neither a draft or prerelease. (updateOnlyUnreleased is on)`) }).toThrow(`Tried to update "release" which is neither a draft or prerelease. (updateOnlyUnreleased is on)`)
}) })
}) })
}) })

View File

@@ -47,10 +47,6 @@ inputs:
description: 'Indicates if release notes should be automatically generated.' description: 'Indicates if release notes should be automatically generated.'
required: false required: false
default: 'false' default: 'false'
makeLatest:
description: 'Indicates if the release should be the "latest" release or not.'
required: false
default: 'legacy'
name: name:
description: 'An optional name for the release. If this is omitted the tag will be used.' description: 'An optional name for the release. If this is omitted the tag will be used.'
required: false required: false
@@ -122,14 +118,8 @@ outputs:
description: 'The HTML URL of the release.' description: 'The HTML URL of the release.'
upload_url: upload_url:
description: 'The URL for uploading assets to the release.' description: 'The URL for uploading assets to the release.'
tarball_url:
description: 'The URL for downloading the release as a tarball (.tar.gz).'
zipball_url:
description: 'The URL for downloading the release as a zipball (.zip).'
assets:
description: 'JSON string containing a map of asset names to download URLs for uploaded assets.'
runs: runs:
using: 'node20' using: 'node16'
main: 'dist/index.js' main: 'dist/index.js'
branding: branding:
icon: 'tag' icon: 'tag'

View File

@@ -1,35 +0,0 @@
{
"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
"vcs": {
"enabled": false,
"clientKind": "git",
"useIgnoreFile": true
},
"files": {
"ignoreUnknown": false,
"ignore": ["node_modules/**/*", "dist/"]
},
"formatter": {
"enabled": true,
"formatWithErrors": false,
"indentStyle": "space",
"lineEnding": "lf",
"indentWidth": 4,
"lineWidth": 120
},
"organizeImports": { "enabled": true },
"linter": {
"enabled": false,
"rules": {
"recommended": true
}
},
"javascript": {
"formatter": {
"quoteStyle": "double",
"trailingCommas": "es5",
"semicolons": "asNeeded",
"indentWidth": 4
}
}
}

45982
dist/index.js vendored

File diff suppressed because one or more lines are too long

2
dist/index.js.map vendored

File diff suppressed because one or more lines are too long

330
dist/licenses.txt vendored
View File

@@ -10,18 +10,6 @@ The above copyright notice and this permission notice shall be included in all c
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@actions/exec
MIT
The MIT License (MIT)
Copyright 2019 GitHub
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@actions/github @actions/github
MIT MIT
The MIT License (MIT) The MIT License (MIT)
@@ -59,40 +47,6 @@ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@actions/io
MIT
The MIT License (MIT)
Copyright 2019 GitHub
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@fastify/busboy
MIT
Copyright Brian White. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
@octokit/auth-token @octokit/auth-token
MIT MIT
The MIT License The MIT License
@@ -265,6 +219,16 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE. THE SOFTWARE.
@vercel/ncc
MIT
Copyright 2018 ZEIT, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
balanced-match balanced-match
MIT MIT
(MIT) (MIT)
@@ -539,11 +503,58 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
fs.realpath
ISC
The ISC License
Copyright (c) Isaac Z. Schlueter and Contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
----
This library bundles a version of the `fs.realpath` and `fs.realpathSync`
methods from Node.js v0.10 under the terms of the Node.js MIT license.
Node's license follows, also included at the header of `old.js` which contains
the licensed code:
Copyright Joyent, Inc. and other Node contributors.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
glob glob
ISC ISC
The ISC License The ISC License
Copyright (c) 2009-2023 Isaac Z. Schlueter and Contributors Copyright (c) 2009-2022 Isaac Z. Schlueter and Contributors
Permission to use, copy, modify, and/or distribute this software for any Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above purpose with or without fee is hereby granted, provided that the above
@@ -558,11 +569,11 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
lru-cache inflight
ISC ISC
The ISC License The ISC License
Copyright (c) 2010-2023 Isaac Z. Schlueter and Contributors Copyright (c) Isaac Z. Schlueter
Permission to use, copy, modify, and/or distribute this software for any Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above purpose with or without fee is hereby granted, provided that the above
@@ -577,11 +588,56 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
inherits
ISC
The ISC License
Copyright (c) Isaac Z. Schlueter
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
is-plain-object
MIT
The MIT License (MIT)
Copyright (c) 2014-2017, Jon Schlinkert.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
minimatch minimatch
ISC ISC
The ISC License The ISC License
Copyright (c) 2011-2023 Isaac Z. Schlueter and Contributors Copyright (c) 2011-2022 Isaac Z. Schlueter and Contributors
Permission to use, copy, modify, and/or distribute this software for any Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above purpose with or without fee is hereby granted, provided that the above
@@ -596,23 +652,30 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
minipass node-fetch
ISC MIT
The ISC License The MIT License (MIT)
Copyright (c) 2017-2023 npm, Inc., Isaac Z. Schlueter, and Contributors Copyright (c) 2016 David Frank
Permission to use, copy, modify, and/or distribute this software for any Permission is hereby granted, free of charge, to any person obtaining a copy
purpose with or without fee is hereby granted, provided that the above of this software and associated documentation files (the "Software"), to deal
copyright notice and this permission notice appear in all copies. in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
once once
@@ -634,64 +697,8 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
path-scurry tr46
BlueOak-1.0.0 MIT
# Blue Oak Model License
Version 1.0.0
## Purpose
This license gives everyone as much permission to work with
this software as possible, while protecting contributors
from liability.
## Acceptance
In order to receive this license, you must agree to its
rules. The rules of this license are both obligations
under that agreement and conditions to your license.
You must not do anything with this software that triggers
a rule that you cannot or will not follow.
## Copyright
Each contributor licenses you to do everything with this
software that would otherwise infringe that contributor's
copyright in it.
## Notices
You must ensure that everyone who gets a copy of
any part of this software from you, with or without
changes, also gets the text of this license or a link to
<https://blueoakcouncil.org/license/1.0.0>.
## Excuse
If anyone notifies you in writing that you have not
complied with [Notices](#notices), you can keep your
license by taking all practical steps to comply within 30
days after the notice. If you do not do so, your license
ends immediately.
## Patent
Each contributor licenses you to do everything with this
software that would otherwise infringe any patent claims
they can license or become able to license.
## Reliability
No contributor can revoke this license.
## No Liability
***As far as the law allows, this software comes as is,
without any warranty or condition, and no contributor
will be liable to anyone for any damages related to this
software or this license, under any kind of legal claim.***
tunnel tunnel
MIT MIT
@@ -718,31 +725,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE. THE SOFTWARE.
undici
MIT
MIT License
Copyright (c) Matteo Collina and Undici contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
universal-user-agent universal-user-agent
ISC ISC
# [ISC License](https://spdx.org/licenses/ISC) # [ISC License](https://spdx.org/licenses/ISC)
@@ -767,6 +749,60 @@ The above copyright notice and this permission notice shall be included in all c
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
uuid
MIT
The MIT License (MIT)
Copyright (c) 2010-2020 Robert Kieffer and other contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
webidl-conversions
BSD-2-Clause
# The BSD 2-Clause License
Copyright (c) 2014, Domenic Denicola
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
whatwg-url
MIT
The MIT License (MIT)
Copyright (c) 20152016 Sebastian Mayr
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
wrappy wrappy
ISC ISC
The ISC License The ISC License

File diff suppressed because one or more lines are too long

129
lib/Action.js Normal file
View File

@@ -0,0 +1,129 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Action = void 0;
const core = __importStar(require("@actions/core"));
const GithubError_1 = require("./GithubError");
const ReleaseValidator_1 = require("./ReleaseValidator");
class Action {
constructor(inputs, outputs, releases, uploader, artifactDestroyer, skipper) {
this.inputs = inputs;
this.outputs = outputs;
this.releases = releases;
this.uploader = uploader;
this.artifactDestroyer = artifactDestroyer;
this.skipper = skipper;
this.releaseValidator = new ReleaseValidator_1.ReleaseValidator(inputs.updateOnlyUnreleased);
}
perform() {
return __awaiter(this, void 0, void 0, function* () {
if (yield this.skipper.shouldSkip()) {
core.notice("Skipping action, release already exists and skipIfReleaseExists is enabled.");
return;
}
const releaseResponse = yield this.createOrUpdateRelease();
const releaseData = releaseResponse.data;
const releaseId = releaseData.id;
const uploadUrl = releaseData.upload_url;
if (this.inputs.removeArtifacts) {
yield this.artifactDestroyer.destroyArtifacts(releaseId);
}
const artifacts = this.inputs.artifacts;
if (artifacts.length > 0) {
yield this.uploader.uploadArtifacts(artifacts, releaseId, uploadUrl);
}
this.outputs.applyReleaseData(releaseData);
});
}
createOrUpdateRelease() {
return __awaiter(this, void 0, void 0, function* () {
if (this.inputs.allowUpdates) {
let getResponse;
try {
getResponse = yield this.releases.getByTag(this.inputs.tag);
}
catch (error) {
return yield this.checkForMissingReleaseError(error);
}
// Fail if this isn't an unreleased release & updateOnlyUnreleased is enabled.
this.releaseValidator.validateReleaseUpdate(getResponse.data);
return yield this.updateRelease(getResponse.data.id);
}
else {
return yield this.createRelease();
}
});
}
checkForMissingReleaseError(error) {
return __awaiter(this, void 0, void 0, function* () {
if (Action.noPublishedRelease(error)) {
return yield this.updateDraftOrCreateRelease();
}
else {
throw error;
}
});
}
updateRelease(id) {
return __awaiter(this, void 0, void 0, function* () {
return yield this.releases.update(id, this.inputs.tag, this.inputs.updatedReleaseBody, this.inputs.commit, this.inputs.discussionCategory, this.inputs.updatedDraft, this.inputs.updatedReleaseName, this.inputs.updatedPrerelease);
});
}
static noPublishedRelease(error) {
const githubError = new GithubError_1.GithubError(error);
return githubError.status == 404;
}
updateDraftOrCreateRelease() {
return __awaiter(this, void 0, void 0, function* () {
const draftReleaseId = yield this.findMatchingDraftReleaseId();
if (draftReleaseId) {
return yield this.updateRelease(draftReleaseId);
}
else {
return yield this.createRelease();
}
});
}
findMatchingDraftReleaseId() {
return __awaiter(this, void 0, void 0, function* () {
const tag = this.inputs.tag;
const response = yield this.releases.listReleases();
const releases = response.data;
const draftRelease = releases.find(release => release.draft && release.tag_name == tag);
return draftRelease === null || draftRelease === void 0 ? void 0 : draftRelease.id;
});
}
createRelease() {
return __awaiter(this, void 0, void 0, function* () {
return yield this.releases.create(this.inputs.tag, this.inputs.createdReleaseBody, this.inputs.commit, this.inputs.discussionCategory, this.inputs.createdDraft, this.inputs.generateReleaseNotes, this.inputs.createdReleaseName, this.inputs.createdPrerelease);
});
}
}
exports.Action = Action;

36
lib/ActionSkipper.js Normal file
View File

@@ -0,0 +1,36 @@
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ReleaseActionSkipper = void 0;
class ReleaseActionSkipper {
constructor(skipIfReleaseExists, releases, tag) {
this.skipIfReleaseExists = skipIfReleaseExists;
this.releases = releases;
this.tag = tag;
}
shouldSkip() {
return __awaiter(this, void 0, void 0, function* () {
if (!this.skipIfReleaseExists) {
// Bail if skip flag isn't set.
return false;
}
try {
const getResponse = yield this.releases.getByTag(this.tag);
return getResponse.data != null;
}
catch (error) {
// There is either no release or something else went wrong. Either way, run the action.
return false;
}
});
}
}
exports.ReleaseActionSkipper = ReleaseActionSkipper;

19
lib/Artifact.js Normal file
View File

@@ -0,0 +1,19 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Artifact = void 0;
const path_1 = require("path");
const fs_1 = require("fs");
class Artifact {
constructor(path, contentType = "raw") {
this.path = path;
this.name = path_1.basename(path);
this.contentType = contentType;
}
get contentLength() {
return fs_1.statSync(this.path).size;
}
readFile() {
return fs_1.readFileSync(this.path);
}
}
exports.Artifact = Artifact;

48
lib/ArtifactDestroyer.js Normal file
View File

@@ -0,0 +1,48 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.GithubArtifactDestroyer = void 0;
const core = __importStar(require("@actions/core"));
class GithubArtifactDestroyer {
constructor(releases) {
this.releases = releases;
}
destroyArtifacts(releaseId) {
return __awaiter(this, void 0, void 0, function* () {
const releaseAssets = yield this.releases.listArtifactsForRelease(releaseId);
for (const artifact of releaseAssets) {
const asset = artifact;
core.debug(`Deleting existing artifact ${artifact.name}...`);
yield this.releases.deleteArtifact(asset.id);
}
});
}
}
exports.GithubArtifactDestroyer = GithubArtifactDestroyer;

73
lib/ArtifactGlobber.js Normal file
View File

@@ -0,0 +1,73 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.FileArtifactGlobber = void 0;
const core = __importStar(require("@actions/core"));
const Globber_1 = require("./Globber");
const Artifact_1 = require("./Artifact");
const untildify_1 = __importDefault(require("untildify"));
const ArtifactPathValidator_1 = require("./ArtifactPathValidator");
const PathNormalizer_1 = require("./PathNormalizer");
class FileArtifactGlobber {
constructor(globber = new Globber_1.FileGlobber()) {
this.globber = globber;
}
globArtifactString(artifact, contentType, errorsFailBuild) {
const split = /[,\n]/;
return artifact.split(split)
.map(path => path.trimStart())
.map(path => PathNormalizer_1.PathNormalizer.normalizePath(path))
.map(path => FileArtifactGlobber.expandPath(path))
.map(pattern => this.globPattern(pattern, errorsFailBuild))
.map((globResult) => FileArtifactGlobber.validatePattern(errorsFailBuild, globResult[1], globResult[0]))
.reduce((accumulated, current) => accumulated.concat(current))
.map(path => new Artifact_1.Artifact(path, contentType));
}
globPattern(pattern, errorsFailBuild) {
const paths = this.globber.glob(pattern);
if (paths.length == 0) {
if (errorsFailBuild) {
FileArtifactGlobber.throwGlobError(pattern);
}
else {
FileArtifactGlobber.reportGlobWarning(pattern);
}
}
return [pattern, paths];
}
static validatePattern(errorsFailBuild, paths, pattern) {
const validator = new ArtifactPathValidator_1.ArtifactPathValidator(errorsFailBuild, paths, pattern);
return validator.validate();
}
static reportGlobWarning(pattern) {
core.warning(`Artifact pattern :${pattern} did not match any files`);
}
static throwGlobError(pattern) {
throw Error(`Artifact pattern :${pattern} did not match any files`);
}
static expandPath(path) {
return untildify_1.default(path);
}
}
exports.FileArtifactGlobber = FileArtifactGlobber;

View File

@@ -0,0 +1,58 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ArtifactPathValidator = void 0;
const core = __importStar(require("@actions/core"));
const fs_1 = require("fs");
class ArtifactPathValidator {
constructor(errorsFailBuild, paths, pattern) {
this.paths = paths;
this.pattern = pattern;
this.errorsFailBuild = errorsFailBuild;
}
validate() {
this.verifyPathsNotEmpty();
return this.paths.filter((path) => this.verifyNotDirectory(path));
}
verifyPathsNotEmpty() {
if (this.paths.length == 0) {
const message = `Artifact pattern:${this.pattern} did not match any files`;
this.reportError(message);
}
}
verifyNotDirectory(path) {
const isDir = fs_1.statSync(path).isDirectory();
if (isDir) {
const message = `Artifact is a directory:${path}. Directories can not be uploaded to a release.`;
this.reportError(message);
}
return !isDir;
}
reportError(message) {
if (this.errorsFailBuild) {
throw Error(message);
}
else {
core.warning(message);
}
}
}
exports.ArtifactPathValidator = ArtifactPathValidator;

88
lib/ArtifactUploader.js Normal file
View File

@@ -0,0 +1,88 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.GithubArtifactUploader = void 0;
const core = __importStar(require("@actions/core"));
class GithubArtifactUploader {
constructor(releases, replacesExistingArtifacts = true, throwsUploadErrors = false) {
this.releases = releases;
this.replacesExistingArtifacts = replacesExistingArtifacts;
this.throwsUploadErrors = throwsUploadErrors;
}
uploadArtifacts(artifacts, releaseId, uploadUrl) {
return __awaiter(this, void 0, void 0, function* () {
if (this.replacesExistingArtifacts) {
yield this.deleteUpdatedArtifacts(artifacts, releaseId);
}
for (const artifact of artifacts) {
yield this.uploadArtifact(artifact, releaseId, uploadUrl);
}
});
}
uploadArtifact(artifact, releaseId, uploadUrl, retry = 3) {
return __awaiter(this, void 0, void 0, function* () {
try {
core.debug(`Uploading artifact ${artifact.name}...`);
yield this.releases.uploadArtifact(uploadUrl, artifact.contentLength, artifact.contentType, artifact.readFile(), artifact.name, releaseId);
}
catch (error) {
if (error.status >= 500 && retry > 0) {
core.warning(`Failed to upload artifact ${artifact.name}. ${error.message}. Retrying...`);
yield this.uploadArtifact(artifact, releaseId, uploadUrl, retry - 1);
}
else {
if (this.throwsUploadErrors) {
throw Error(`Failed to upload artifact ${artifact.name}. ${error.message}.`);
}
else {
core.warning(`Failed to upload artifact ${artifact.name}. ${error.message}.`);
}
}
}
});
}
deleteUpdatedArtifacts(artifacts, releaseId) {
return __awaiter(this, void 0, void 0, function* () {
const releaseAssets = yield this.releases.listArtifactsForRelease(releaseId);
const assetByName = {};
releaseAssets.forEach(asset => {
assetByName[asset.name] = asset;
});
for (const artifact of artifacts) {
const asset = assetByName[artifact.name];
if (asset) {
core.debug(`Deleting existing artifact ${artifact.name}...`);
yield this.releases.deleteArtifact(asset.id);
}
}
});
}
}
exports.GithubArtifactUploader = GithubArtifactUploader;

40
lib/GithubError.js Normal file
View File

@@ -0,0 +1,40 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.GithubError = void 0;
const GithubErrorDetail_1 = require("./GithubErrorDetail");
class GithubError {
constructor(error) {
this.error = error;
this.githubErrors = this.generateGithubErrors();
}
generateGithubErrors() {
const errors = this.error.errors;
if (errors instanceof Array) {
return errors.map((err) => new GithubErrorDetail_1.GithubErrorDetail(err));
}
else {
return [];
}
}
get status() {
return this.error.status;
}
hasErrorWithCode(code) {
return this.githubErrors.some((err) => err.code == code);
}
toString() {
const message = this.error.message;
const errors = this.githubErrors;
const status = this.status;
if (errors.length > 0) {
return `Error ${status}: ${message}\nErrors:\n${this.errorBulletedList(errors)}`;
}
else {
return `Error ${status}: ${message}`;
}
}
errorBulletedList(errors) {
return errors.map((err) => `- ${err}`).join("\n");
}
}
exports.GithubError = GithubError;

57
lib/GithubErrorDetail.js Normal file
View File

@@ -0,0 +1,57 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.GithubErrorDetail = void 0;
class GithubErrorDetail {
constructor(error) {
this.error = error;
}
get code() {
return this.error.code;
}
toString() {
const code = this.error.code;
switch (code) {
case 'missing':
return this.missingResourceMessage();
case 'missing_field':
return this.missingFieldMessage();
case 'invalid':
return this.invalidFieldMessage();
case 'already_exists':
return this.resourceAlreadyExists();
default:
return this.customErrorMessage();
}
}
customErrorMessage() {
const message = this.error.message;
const documentation = this.error.documentation_url;
let documentationMessage;
if (documentation) {
documentationMessage = `\nPlease see ${documentation}.`;
}
else {
documentationMessage = "";
}
return `${message}${documentationMessage}`;
}
invalidFieldMessage() {
const resource = this.error.resource;
const field = this.error.field;
return `The ${field} field on ${resource} is an invalid format.`;
}
missingResourceMessage() {
const resource = this.error.resource;
return `${resource} does not exist.`;
}
missingFieldMessage() {
const resource = this.error.resource;
const field = this.error.field;
return `The ${field} field on ${resource} is missing.`;
}
resourceAlreadyExists() {
const resource = this.error.resource;
return `${resource} already exists.`;
}
}
exports.GithubErrorDetail = GithubErrorDetail;

10
lib/Globber.js Normal file
View File

@@ -0,0 +1,10 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.FileGlobber = void 0;
const glob_1 = require("glob");
class FileGlobber {
glob(pattern) {
return new glob_1.GlobSync(pattern, { mark: true }).found;
}
}
exports.FileGlobber = FileGlobber;

192
lib/Inputs.js Normal file
View File

@@ -0,0 +1,192 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.CoreInputs = void 0;
const core = __importStar(require("@actions/core"));
const fs_1 = require("fs");
class CoreInputs {
constructor(artifactGlobber, context) {
this.artifactGlobber = artifactGlobber;
this.context = context;
}
get allowUpdates() {
const allow = core.getInput('allowUpdates');
return allow == 'true';
}
get artifacts() {
let artifacts = core.getInput('artifacts');
if (!artifacts) {
artifacts = core.getInput('artifact');
}
if (artifacts) {
let contentType = core.getInput('artifactContentType');
if (!contentType) {
contentType = 'raw';
}
return this.artifactGlobber
.globArtifactString(artifacts, contentType, this.artifactErrorsFailBuild);
}
return [];
}
get artifactErrorsFailBuild() {
const allow = core.getInput('artifactErrorsFailBuild');
return allow == 'true';
}
get body() {
const body = core.getInput('body');
if (body) {
return body;
}
const bodyFile = core.getInput('bodyFile');
if (bodyFile) {
return this.stringFromFile(bodyFile);
}
return '';
}
get createdDraft() {
const draft = core.getInput('draft');
return draft == 'true';
}
get createdPrerelease() {
const preRelease = core.getInput('prerelease');
return preRelease == 'true';
}
get createdReleaseBody() {
if (CoreInputs.omitBody)
return undefined;
return this.body;
}
static get omitBody() {
return core.getInput('omitBody') == 'true';
}
get createdReleaseName() {
if (CoreInputs.omitName)
return undefined;
return this.name;
}
static get omitName() {
return core.getInput('omitName') == 'true';
}
get commit() {
const commit = core.getInput('commit');
if (commit) {
return commit;
}
return undefined;
}
get discussionCategory() {
const category = core.getInput('discussionCategory');
if (category) {
return category;
}
return undefined;
}
get name() {
const name = core.getInput('name');
if (name) {
return name;
}
return this.tag;
}
get generateReleaseNotes() {
const generate = core.getInput('generateReleaseNotes');
return generate == 'true';
}
get owner() {
let owner = core.getInput('owner');
if (owner) {
return owner;
}
return this.context.repo.owner;
}
get removeArtifacts() {
const removes = core.getInput('removeArtifacts');
return removes == 'true';
}
get replacesArtifacts() {
const replaces = core.getInput('replacesArtifacts');
return replaces == 'true';
}
get repo() {
let repo = core.getInput('repo');
if (repo) {
return repo;
}
return this.context.repo.repo;
}
get skipIfReleaseExists() {
return core.getBooleanInput("skipIfReleaseExists");
}
get tag() {
const tag = core.getInput('tag');
if (tag) {
return tag;
}
const ref = this.context.ref;
const tagPath = "refs/tags/";
if (ref && ref.startsWith(tagPath)) {
return ref.substr(tagPath.length, ref.length);
}
throw Error("No tag found in ref or input!");
}
get token() {
return core.getInput('token', { required: true });
}
get updatedDraft() {
if (CoreInputs.omitDraftDuringUpdate)
return undefined;
return this.createdDraft;
}
static get omitDraftDuringUpdate() {
return core.getInput('omitDraftDuringUpdate') == 'true';
}
get updatedPrerelease() {
if (CoreInputs.omitPrereleaseDuringUpdate)
return undefined;
return this.createdPrerelease;
}
static get omitPrereleaseDuringUpdate() {
return core.getInput('omitPrereleaseDuringUpdate') == 'true';
}
get updatedReleaseBody() {
if (CoreInputs.omitBody || CoreInputs.omitBodyDuringUpdate)
return undefined;
return this.body;
}
static get omitBodyDuringUpdate() {
return core.getInput('omitBodyDuringUpdate') == 'true';
}
get updatedReleaseName() {
if (CoreInputs.omitName || CoreInputs.omitNameDuringUpdate)
return undefined;
return this.name;
}
get updateOnlyUnreleased() {
return core.getInput('updateOnlyUnreleased') == 'true';
}
static get omitNameDuringUpdate() {
return core.getInput('omitNameDuringUpdate') == 'true';
}
stringFromFile(path) {
return fs_1.readFileSync(path, 'utf-8');
}
}
exports.CoreInputs = CoreInputs;

67
lib/Main.js Normal file
View File

@@ -0,0 +1,67 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
const github = __importStar(require("@actions/github"));
const core = __importStar(require("@actions/core"));
const Inputs_1 = require("./Inputs");
const Releases_1 = require("./Releases");
const Action_1 = require("./Action");
const ArtifactUploader_1 = require("./ArtifactUploader");
const ArtifactGlobber_1 = require("./ArtifactGlobber");
const GithubError_1 = require("./GithubError");
const Outputs_1 = require("./Outputs");
const ArtifactDestroyer_1 = require("./ArtifactDestroyer");
const ActionSkipper_1 = require("./ActionSkipper");
function run() {
return __awaiter(this, void 0, void 0, function* () {
try {
const action = createAction();
yield action.perform();
}
catch (error) {
const githubError = new GithubError_1.GithubError(error);
core.setFailed(githubError.toString());
}
});
}
function createAction() {
const token = core.getInput('token');
const context = github.context;
const git = github.getOctokit(token);
const globber = new ArtifactGlobber_1.FileArtifactGlobber();
const inputs = new Inputs_1.CoreInputs(globber, context);
const outputs = new Outputs_1.CoreOutputs();
const releases = new Releases_1.GithubReleases(inputs, git);
const skipper = new ActionSkipper_1.ReleaseActionSkipper(inputs.skipIfReleaseExists, releases, inputs.tag);
const uploader = new ArtifactUploader_1.GithubArtifactUploader(releases, inputs.replacesArtifacts, inputs.artifactErrorsFailBuild);
const artifactDestroyer = new ArtifactDestroyer_1.GithubArtifactDestroyer(releases);
return new Action_1.Action(inputs, outputs, releases, uploader, artifactDestroyer, skipper);
}
run();

31
lib/Outputs.js Normal file
View File

@@ -0,0 +1,31 @@
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.CoreOutputs = void 0;
const core = __importStar(require("@actions/core"));
class CoreOutputs {
applyReleaseData(releaseData) {
core.setOutput('id', releaseData.id);
core.setOutput('html_url', releaseData.html_url);
core.setOutput('upload_url', releaseData.upload_url);
}
}
exports.CoreOutputs = CoreOutputs;

13
lib/PathNormalizer.js Normal file
View File

@@ -0,0 +1,13 @@
"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.PathNormalizer = void 0;
const path_1 = __importDefault(require("path"));
class PathNormalizer {
static normalizePath(pathString) {
return pathString.split(path_1.default.sep).join("/");
}
}
exports.PathNormalizer = PathNormalizer;

18
lib/ReleaseValidator.js Normal file
View File

@@ -0,0 +1,18 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ReleaseValidator = void 0;
class ReleaseValidator {
constructor(updateOnlyUnreleased) {
this.updateOnlyUnreleased = updateOnlyUnreleased;
}
validateReleaseUpdate(releaseResponse) {
var _a;
if (!this.updateOnlyUnreleased) {
return;
}
if (!releaseResponse.draft && !releaseResponse.prerelease) {
throw new Error(`Tried to update "${(_a = releaseResponse.name) !== null && _a !== void 0 ? _a : "release"}" which is neither a draft or prerelease. (updateOnlyUnreleased is on)`);
}
}
}
exports.ReleaseValidator = ReleaseValidator;

104
lib/Releases.js Normal file
View File

@@ -0,0 +1,104 @@
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.GithubReleases = void 0;
class GithubReleases {
constructor(inputs, git) {
this.inputs = inputs;
this.git = git;
}
create(tag, body, commitHash, discussionCategory, draft, generateReleaseNotes, name, prerelease) {
return __awaiter(this, void 0, void 0, function* () {
// noinspection TypeScriptValidateJSTypes
return this.git.rest.repos.createRelease({
body: body,
name: name,
discussion_category_name: discussionCategory,
draft: draft,
generate_release_notes: generateReleaseNotes,
owner: this.inputs.owner,
prerelease: prerelease,
repo: this.inputs.repo,
target_commitish: commitHash,
tag_name: tag
});
});
}
deleteArtifact(assetId) {
return __awaiter(this, void 0, void 0, function* () {
return this.git.rest.repos.deleteReleaseAsset({
asset_id: assetId,
owner: this.inputs.owner,
repo: this.inputs.repo
});
});
}
getByTag(tag) {
return __awaiter(this, void 0, void 0, function* () {
return this.git.rest.repos.getReleaseByTag({
owner: this.inputs.owner,
repo: this.inputs.repo,
tag: tag
});
});
}
listArtifactsForRelease(releaseId) {
return __awaiter(this, void 0, void 0, function* () {
return this.git.paginate(this.git.rest.repos.listReleaseAssets, {
owner: this.inputs.owner,
release_id: releaseId,
repo: this.inputs.repo
});
});
}
listReleases() {
return __awaiter(this, void 0, void 0, function* () {
return this.git.rest.repos.listReleases({
owner: this.inputs.owner,
repo: this.inputs.repo
});
});
}
update(id, tag, body, commitHash, discussionCategory, draft, name, prerelease) {
return __awaiter(this, void 0, void 0, function* () {
// noinspection TypeScriptValidateJSTypes
return this.git.rest.repos.updateRelease({
release_id: id,
body: body,
name: name,
discussion_category_name: discussionCategory,
draft: draft,
owner: this.inputs.owner,
prerelease: prerelease,
repo: this.inputs.repo,
target_commitish: commitHash,
tag_name: tag
});
});
}
uploadArtifact(assetUrl, contentLength, contentType, file, name, releaseId) {
return __awaiter(this, void 0, void 0, function* () {
return this.git.rest.repos.uploadReleaseAsset({
url: assetUrl,
headers: {
"content-length": contentLength,
"content-type": contentType
},
data: file,
name: name,
owner: this.inputs.owner,
release_id: releaseId,
repo: this.inputs.repo
});
});
}
}
exports.GithubReleases = GithubReleases;

View File

@@ -1,66 +1,71 @@
{ {
"name": "release-action", "name": "release-action",
"version": "1.1.0", "version": "1.1.0",
"private": true, "private": true,
"description": "An action which manages a github release", "description": "An action which manages a github release",
"main": "lib/main.js", "main": "lib/main.js",
"scripts": { "scripts": {
"build": "tsc", "build": "tsc",
"clean": "rm -rf lib/*", "clean": "rm -rf lib/*",
"coverage": "jest --coverage", "coverage": "jest --coverage",
"debug": "yarn clean && yarn install && yarn build && yarn package", "debug": "yarn clean && yarn install && yarn build && yarn package",
"format": "yarn biome format --write .", "package": "ncc build --source-map --license licenses.txt",
"package": "ncc build --source-map --license licenses.txt", "release": "yarn clean && yarn install --production && yarn build && yarn package",
"release": "yarn clean && yarn install --production && yarn build && yarn package", "test": "jest"
"test": "jest" },
"repository": {
"type": "git",
"url": "git+https://github.com/ncipollo/release-action.git"
},
"keywords": [
"actions",
"node",
"setup"
],
"author": "GitHub",
"license": "MIT",
"jest": {
"clearMocks": true,
"collectCoverage": true,
"coveragePathIgnorePatterns": [
"src/Globber.ts",
"src/Releases.ts"
],
"coverageThreshold": {
"global": {
"branches": 95,
"functions": 100,
"lines": 100,
"statements": 100
}
}, },
"repository": { "moduleFileExtensions": [
"type": "git", "js",
"url": "git+https://github.com/ncipollo/release-action.git" "ts"
],
"testEnvironment": "node",
"testMatch": [
"**/*.test.ts"
],
"testRunner": "jest-circus/runner",
"transform": {
"^.+\\.ts$": "ts-jest"
}, },
"keywords": ["actions", "node", "setup"], "verbose": true
"author": "GitHub", },
"license": "MIT", "dependencies": {
"engines": { "@actions/core": "^1.10.0",
"node": ">=20" "@actions/github": "^5.1.1",
}, "@types/glob": "^8.0.0",
"jest": { "glob": "^8.0.3",
"clearMocks": true, "untildify": "^4.0.0"
"collectCoverage": true, },
"coveragePathIgnorePatterns": ["src/Globber.ts", "src/Releases.ts"], "devDependencies": {
"coverageThreshold": { "@types/jest": "^28.1.1",
"global": { "@types/node": "^18.11.8",
"branches": 95, "jest": "^28.1.1",
"functions": 100, "jest-circus": "^29.2.2",
"lines": 100, "ts-jest": "^28.0.5",
"statements": 100 "typescript": "^4.8.4"
} }
},
"moduleFileExtensions": ["js", "ts"],
"testEnvironment": "node",
"testMatch": ["**/*.test.ts"],
"testRunner": "jest-circus/runner",
"transform": {
"^.+\\.ts$": "ts-jest"
},
"verbose": true
},
"dependencies": {
"@actions/core": "^1.11.1",
"@actions/github": "^6.0.1",
"@types/node": "^22.15.29",
"glob": "^11.0.2",
"untildify": "^4.0.0"
},
"devDependencies": {
"@biomejs/biome": "1.9.4",
"@types/jest": "^29.5.14",
"jest": "^29.7.0",
"jest-circus": "^29.7.0",
"ts-jest": "^29.3.4",
"typescript": "^5.8.3"
},
"resolutions": {
"jest-cli/yargs": "^17.3.1"
}
} }

View File

@@ -1,6 +0,0 @@
[repository]
enable_commit = true
tag_pattern = "v{version}"
[scripts]
before_commit = "yarn release"

View File

@@ -1,18 +1,18 @@
import * as core from "@actions/core" import * as core from '@actions/core';
import type { ActionSkipper } from "./ActionSkipper" import {Inputs} from "./Inputs";
import type { ArtifactDestroyer } from "./ArtifactDestroyer" import {
import type { ArtifactUploader } from "./ArtifactUploader"
import { GithubError } from "./GithubError"
import type { Inputs } from "./Inputs"
import type { Outputs } from "./Outputs"
import { ReleaseValidator } from "./ReleaseValidator"
import type {
CreateOrUpdateReleaseResponse, CreateOrUpdateReleaseResponse,
CreateReleaseResponse, CreateReleaseResponse,
ReleaseByTagResponse, ReleaseByTagResponse,
Releases, Releases,
UpdateReleaseResponse, UpdateReleaseResponse
} from "./Releases" } from "./Releases";
import {ArtifactUploader} from "./ArtifactUploader";
import {GithubError} from "./GithubError";
import {Outputs} from "./Outputs";
import {ArtifactDestroyer} from "./ArtifactDestroyer";
import {ReleaseValidator} from "./ReleaseValidator";
import {ActionSkipper} from "./ActionSkipper";
export class Action { export class Action {
private inputs: Inputs private inputs: Inputs
@@ -21,17 +21,15 @@ export class Action {
private uploader: ArtifactUploader private uploader: ArtifactUploader
private artifactDestroyer: ArtifactDestroyer private artifactDestroyer: ArtifactDestroyer
private skipper: ActionSkipper private skipper: ActionSkipper
private releaseValidator: ReleaseValidator private releaseValidator: ReleaseValidator
constructor( constructor(inputs: Inputs,
inputs: Inputs, outputs: Outputs,
outputs: Outputs, releases: Releases,
releases: Releases, uploader: ArtifactUploader,
uploader: ArtifactUploader, artifactDestroyer: ArtifactDestroyer,
artifactDestroyer: ArtifactDestroyer, skipper: ActionSkipper) {
skipper: ActionSkipper
) {
this.inputs = inputs this.inputs = inputs
this.outputs = outputs this.outputs = outputs
this.releases = releases this.releases = releases
@@ -46,24 +44,22 @@ export class Action {
core.notice("Skipping action, release already exists and skipIfReleaseExists is enabled.") core.notice("Skipping action, release already exists and skipIfReleaseExists is enabled.")
return return
} }
const releaseResponse = await this.createOrUpdateRelease() const releaseResponse = await this.createOrUpdateRelease();
const releaseData = releaseResponse.data const releaseData = releaseResponse.data
const releaseId = releaseData.id const releaseId = releaseData.id
const uploadUrl = releaseData.upload_url const uploadUrl = releaseData.upload_url
if (this.inputs.removeArtifacts) { if (this.inputs.removeArtifacts) {
await this.artifactDestroyer.destroyArtifacts(releaseId) await this.artifactDestroyer.destroyArtifacts(releaseId)
} }
const artifacts = this.inputs.artifacts const artifacts = this.inputs.artifacts
let assetUrls: Record<string, string> = {}
if (artifacts.length > 0) { if (artifacts.length > 0) {
assetUrls = await this.uploader.uploadArtifacts(artifacts, releaseId, uploadUrl) await this.uploader.uploadArtifacts(artifacts, releaseId, uploadUrl)
} }
this.outputs.applyReleaseData(releaseData) this.outputs.applyReleaseData(releaseData)
this.outputs.applyAssetUrls(assetUrls)
} }
private async createOrUpdateRelease(): Promise<CreateOrUpdateReleaseResponse> { private async createOrUpdateRelease(): Promise<CreateOrUpdateReleaseResponse> {
@@ -74,7 +70,7 @@ export class Action {
} catch (error: any) { } catch (error: any) {
return await this.checkForMissingReleaseError(error) return await this.checkForMissingReleaseError(error)
} }
// Fail if this isn't an unreleased release & updateOnlyUnreleased is enabled. // Fail if this isn't an unreleased release & updateOnlyUnreleased is enabled.
this.releaseValidator.validateReleaseUpdate(getResponse.data) this.releaseValidator.validateReleaseUpdate(getResponse.data)
@@ -93,21 +89,13 @@ export class Action {
} }
private async updateRelease(id: number): Promise<UpdateReleaseResponse> { private async updateRelease(id: number): Promise<UpdateReleaseResponse> {
let releaseBody = this.inputs.updatedReleaseBody
if (this.inputs.generateReleaseNotes && !this.inputs.omitBodyDuringUpdate) {
const response = await this.releases.generateReleaseNotes(this.inputs.tag)
releaseBody = response.data.body
}
return await this.releases.update( return await this.releases.update(
id, id,
this.inputs.tag, this.inputs.tag,
releaseBody, this.inputs.updatedReleaseBody,
this.inputs.commit, this.inputs.commit,
this.inputs.discussionCategory, this.inputs.discussionCategory,
this.inputs.updatedDraft, this.inputs.updatedDraft,
this.inputs.makeLatest,
this.inputs.updatedReleaseName, this.inputs.updatedReleaseName,
this.inputs.updatedPrerelease this.inputs.updatedPrerelease
) )
@@ -131,11 +119,7 @@ export class Action {
const tag = this.inputs.tag const tag = this.inputs.tag
const response = await this.releases.listReleases() const response = await this.releases.listReleases()
const releases = response.data const releases = response.data
if (!releases) { const draftRelease = releases.find(release => release.draft && release.tag_name == tag)
throw new Error(`No releases found. Response: ${JSON.stringify(response)}`)
}
const draftRelease = releases.find((release) => release.draft && release.tag_name == tag)
return draftRelease?.id return draftRelease?.id
} }
@@ -148,7 +132,6 @@ export class Action {
this.inputs.discussionCategory, this.inputs.discussionCategory,
this.inputs.createdDraft, this.inputs.createdDraft,
this.inputs.generateReleaseNotes, this.inputs.generateReleaseNotes,
this.inputs.makeLatest,
this.inputs.createdReleaseName, this.inputs.createdReleaseName,
this.inputs.createdPrerelease this.inputs.createdPrerelease
) )

View File

@@ -1,20 +1,19 @@
import { Releases } from "./Releases" import {Releases} from "./Releases";
export interface ActionSkipper { export interface ActionSkipper {
shouldSkip(): Promise<boolean> shouldSkip(): Promise<boolean>
} }
export class ReleaseActionSkipper { export class ReleaseActionSkipper {
constructor( constructor(private skipIfReleaseExists: boolean,
private skipIfReleaseExists: boolean, private releases: Releases,
private releases: Releases, private tag: string) {
private tag: string }
) {}
async shouldSkip(): Promise<boolean> { async shouldSkip(): Promise<boolean> {
if (!this.skipIfReleaseExists) { if (!this.skipIfReleaseExists) {
// Bail if skip flag isn't set. // Bail if skip flag isn't set.
return false return false;
} }
try { try {
@@ -22,7 +21,7 @@ export class ReleaseActionSkipper {
return getResponse.data != null return getResponse.data != null
} catch (error: any) { } catch (error: any) {
// There is either no release or something else went wrong. Either way, run the action. // There is either no release or something else went wrong. Either way, run the action.
return false return false;
} }
} }
} }

View File

@@ -1,5 +1,5 @@
import { basename } from "path" import { basename } from "path";
import { createReadStream, readFileSync, ReadStream, statSync } from "fs" import { readFileSync, statSync } from "fs";
export class Artifact { export class Artifact {
readonly contentType: string readonly contentType: string
@@ -9,14 +9,14 @@ export class Artifact {
constructor(path: string, contentType: string = "raw") { constructor(path: string, contentType: string = "raw") {
this.path = path this.path = path
this.name = basename(path) this.name = basename(path)
this.contentType = contentType this.contentType = contentType;
} }
get contentLength(): number { get contentLength(): number {
return statSync(this.path).size return statSync(this.path).size
} }
readFile(): ReadStream { readFile(): Buffer {
return createReadStream(this.path) return readFileSync(this.path)
} }
} }

View File

@@ -1,12 +1,13 @@
import { Releases } from "./Releases" import {Releases} from "./Releases";
import * as core from "@actions/core" import * as core from "@actions/core";
export interface ArtifactDestroyer { export interface ArtifactDestroyer {
destroyArtifacts(releaseId: number): Promise<void> destroyArtifacts(releaseId: number): Promise<void>
} }
export class GithubArtifactDestroyer implements ArtifactDestroyer { export class GithubArtifactDestroyer implements ArtifactDestroyer {
constructor(private releases: Releases) {} constructor(private releases: Releases) {
}
async destroyArtifacts(releaseId: number): Promise<void> { async destroyArtifacts(releaseId: number): Promise<void> {
const releaseAssets = await this.releases.listArtifactsForRelease(releaseId) const releaseAssets = await this.releases.listArtifactsForRelease(releaseId)
@@ -16,4 +17,4 @@ export class GithubArtifactDestroyer implements ArtifactDestroyer {
await this.releases.deleteArtifact(asset.id) await this.releases.deleteArtifact(asset.id)
} }
} }
} }

View File

@@ -1,9 +1,9 @@
import * as core from "@actions/core" import * as core from '@actions/core';
import { Globber, FileGlobber } from "./Globber" import {Globber, FileGlobber} from "./Globber";
import { Artifact } from "./Artifact" import {Artifact} from "./Artifact";
import untildify from "untildify" import untildify from "untildify";
import { ArtifactPathValidator } from "./ArtifactPathValidator" import {ArtifactPathValidator} from "./ArtifactPathValidator";
import { PathNormalizer } from "./PathNormalizer" import {PathNormalizer} from "./PathNormalizer";
export interface ArtifactGlobber { export interface ArtifactGlobber {
globArtifactString(artifact: string, contentType: string, errorsFailBuild: boolean): Artifact[] globArtifactString(artifact: string, contentType: string, errorsFailBuild: boolean): Artifact[]
@@ -18,15 +18,14 @@ export class FileArtifactGlobber implements ArtifactGlobber {
globArtifactString(artifact: string, contentType: string, errorsFailBuild: boolean): Artifact[] { globArtifactString(artifact: string, contentType: string, errorsFailBuild: boolean): Artifact[] {
const split = /[,\n]/ const split = /[,\n]/
return artifact return artifact.split(split)
.split(split) .map(path => path.trimStart())
.map((path) => path.trimStart()) .map(path => PathNormalizer.normalizePath(path))
.map((path) => PathNormalizer.normalizePath(path)) .map(path => FileArtifactGlobber.expandPath(path))
.map((path) => FileArtifactGlobber.expandPath(path)) .map(pattern => this.globPattern(pattern, errorsFailBuild))
.map((pattern) => this.globPattern(pattern, errorsFailBuild))
.map((globResult) => FileArtifactGlobber.validatePattern(errorsFailBuild, globResult[1], globResult[0])) .map((globResult) => FileArtifactGlobber.validatePattern(errorsFailBuild, globResult[1], globResult[0]))
.reduce((accumulated, current) => accumulated.concat(current)) .reduce((accumulated, current) => accumulated.concat(current))
.map((path) => new Artifact(path, contentType)) .map(path => new Artifact(path, contentType))
} }
private globPattern(pattern: string, errorsFailBuild: boolean): [string, string[]] { private globPattern(pattern: string, errorsFailBuild: boolean): [string, string[]] {
@@ -57,4 +56,4 @@ export class FileArtifactGlobber implements ArtifactGlobber {
private static expandPath(path: string): string { private static expandPath(path: string): string {
return untildify(path) return untildify(path)
} }
} }

View File

@@ -1,29 +1,29 @@
import * as core from "@actions/core" import * as core from "@actions/core";
import { statSync } from "fs" import {statSync} from "fs";
export class ArtifactPathValidator { export class ArtifactPathValidator {
private readonly errorsFailBuild: boolean private readonly errorsFailBuild: boolean;
private paths: string[] private paths: string[];
private readonly pattern: string private readonly pattern: string
constructor(errorsFailBuild: boolean, paths: string[], pattern: string) { constructor(errorsFailBuild: boolean, paths: string[], pattern: string) {
this.paths = paths this.paths = paths;
this.pattern = pattern this.pattern = pattern
this.errorsFailBuild = errorsFailBuild this.errorsFailBuild = errorsFailBuild;
} }
validate(): string[] { validate(): string[] {
this.verifyPathsNotEmpty() this.verifyPathsNotEmpty()
return this.paths.filter((path) => this.verifyNotDirectory(path)) return this.paths.filter((path) => this.verifyNotDirectory(path))
} }
private verifyPathsNotEmpty() { private verifyPathsNotEmpty() {
if (this.paths.length == 0) { if (this.paths.length == 0) {
const message = `Artifact pattern:${this.pattern} did not match any files` const message = `Artifact pattern:${this.pattern} did not match any files`
this.reportError(message) this.reportError(message)
} }
} }
private verifyNotDirectory(path: string): boolean { private verifyNotDirectory(path: string): boolean {
const isDir = statSync(path).isDirectory() const isDir = statSync(path).isDirectory()
if (isDir) { if (isDir) {
@@ -32,7 +32,7 @@ export class ArtifactPathValidator {
} }
return !isDir return !isDir
} }
private reportError(message: string) { private reportError(message: string) {
if (this.errorsFailBuild) { if (this.errorsFailBuild) {
throw Error(message) throw Error(message)
@@ -40,4 +40,4 @@ export class ArtifactPathValidator {
core.warning(message) core.warning(message)
} }
} }
} }

View File

@@ -1,54 +1,51 @@
import * as core from "@actions/core" import * as core from '@actions/core';
import { Artifact } from "./Artifact" import {Artifact} from "./Artifact";
import { Releases } from "./Releases" import {Releases} from "./Releases";
export interface ArtifactUploader { export interface ArtifactUploader {
uploadArtifacts(artifacts: Artifact[], releaseId: number, uploadUrl: string): Promise<Record<string, string>> uploadArtifacts(artifacts: Artifact[], releaseId: number, uploadUrl: string): Promise<void>
} }
export class GithubArtifactUploader implements ArtifactUploader { export class GithubArtifactUploader implements ArtifactUploader {
constructor( constructor(
private releases: Releases, private releases: Releases,
private replacesExistingArtifacts: boolean = true, private replacesExistingArtifacts: boolean = true,
private throwsUploadErrors: boolean = false private throwsUploadErrors: boolean = false,
) {} ) {
}
async uploadArtifacts(artifacts: Artifact[], releaseId: number, uploadUrl: string): Promise<Record<string, string>> { async uploadArtifacts(artifacts: Artifact[],
releaseId: number,
uploadUrl: string): Promise<void> {
if (this.replacesExistingArtifacts) { if (this.replacesExistingArtifacts) {
await this.deleteUpdatedArtifacts(artifacts, releaseId) await this.deleteUpdatedArtifacts(artifacts, releaseId)
} }
const assetUrls: Record<string, string> = {}
for (const artifact of artifacts) { for (const artifact of artifacts) {
const assetUrl = await this.uploadArtifact(artifact, releaseId, uploadUrl) await this.uploadArtifact(artifact, releaseId, uploadUrl)
if (assetUrl !== null) {
assetUrls[artifact.name] = assetUrl
}
} }
return assetUrls
} }
private async uploadArtifact(artifact: Artifact, releaseId: number, uploadUrl: string, retry = 3): Promise<string | null> { private async uploadArtifact(artifact: Artifact,
releaseId: number,
uploadUrl: string,
retry = 3) {
try { try {
core.debug(`Uploading artifact ${artifact.name}...`) core.debug(`Uploading artifact ${artifact.name}...`)
const assetResponse = await this.releases.uploadArtifact( await this.releases.uploadArtifact(uploadUrl,
uploadUrl,
artifact.contentLength, artifact.contentLength,
artifact.contentType, artifact.contentType,
artifact.readFile(), artifact.readFile(),
artifact.name, artifact.name,
releaseId releaseId)
)
return assetResponse.data.browser_download_url
} catch (error: any) { } catch (error: any) {
if (error.status >= 500 && retry > 0) { if (error.status >= 500 && retry > 0) {
core.warning(`Failed to upload artifact ${artifact.name}. ${error.message}. Retrying...`) core.warning(`Failed to upload artifact ${artifact.name}. ${error.message}. Retrying...`)
return this.uploadArtifact(artifact, releaseId, uploadUrl, retry - 1) await this.uploadArtifact(artifact, releaseId, uploadUrl, retry - 1)
} else { } else {
if (this.throwsUploadErrors) { if (this.throwsUploadErrors) {
throw Error(`Failed to upload artifact ${artifact.name}. ${error.message}.`) throw Error(`Failed to upload artifact ${artifact.name}. ${error.message}.`)
} else { } else {
core.warning(`Failed to upload artifact ${artifact.name}. ${error.message}.`) core.warning(`Failed to upload artifact ${artifact.name}. ${error.message}.`)
return null
} }
} }
} }
@@ -57,9 +54,9 @@ export class GithubArtifactUploader implements ArtifactUploader {
private async deleteUpdatedArtifacts(artifacts: Artifact[], releaseId: number): Promise<void> { private async deleteUpdatedArtifacts(artifacts: Artifact[], releaseId: number): Promise<void> {
const releaseAssets = await this.releases.listArtifactsForRelease(releaseId) const releaseAssets = await this.releases.listArtifactsForRelease(releaseId)
const assetByName: Record<string, { id: number; name: string }> = {} const assetByName: Record<string, { id: number; name: string }> = {}
releaseAssets.forEach((asset) => { releaseAssets.forEach(asset => {
assetByName[asset.name] = asset assetByName[asset.name] = asset
}) });
for (const artifact of artifacts) { for (const artifact of artifacts) {
const asset = assetByName[artifact.name] const asset = assetByName[artifact.name]
if (asset) { if (asset) {

View File

@@ -1,4 +1,4 @@
import { GithubErrorDetail } from "./GithubErrorDetail" import {GithubErrorDetail} from "./GithubErrorDetail"
export class GithubError { export class GithubError {
private error: any private error: any
@@ -31,20 +31,14 @@ export class GithubError {
const errors = this.githubErrors const errors = this.githubErrors
const status = this.status const status = this.status
if (errors.length > 0) { if (errors.length > 0) {
return `Error ${status}: ${message}\nErrors:\n${this.errorBulletedList(errors)}${this.remediation()}` return `Error ${status}: ${message}\nErrors:\n${this.errorBulletedList(errors)}`
} else { } else {
return `Error ${status}: ${message}${this.remediation()}` return `Error ${status}: ${message}`
} }
} }
private errorBulletedList(errors: GithubErrorDetail[]): string { private errorBulletedList(errors: GithubErrorDetail[]): string {
return errors.map((err) => `- ${err}`).join("\n") return errors.map((err) => `- ${err}`).join("\n")
} }
private remediation(): String {
if (this.status == 404) {
return "\nMake sure your github token has access to the repo and has permission to author releases"
}
return ""
}
} }

View File

@@ -1,5 +1,5 @@
export class GithubErrorDetail { export class GithubErrorDetail {
private error: any private error: any;
constructor(error: any) { constructor(error: any) {
this.error = error this.error = error
@@ -12,13 +12,13 @@ export class GithubErrorDetail {
toString(): string { toString(): string {
const code = this.error.code const code = this.error.code
switch (code) { switch (code) {
case "missing": case 'missing':
return this.missingResourceMessage() return this.missingResourceMessage()
case "missing_field": case 'missing_field':
return this.missingFieldMessage() return this.missingFieldMessage()
case "invalid": case 'invalid':
return this.invalidFieldMessage() return this.invalidFieldMessage()
case "already_exists": case 'already_exists':
return this.resourceAlreadyExists() return this.resourceAlreadyExists()
default: default:
return this.customErrorMessage() return this.customErrorMessage()
@@ -26,7 +26,7 @@ export class GithubErrorDetail {
} }
private customErrorMessage(): string { private customErrorMessage(): string {
const message = this.error.message const message = this.error.message;
const documentation = this.error.documentation_url const documentation = this.error.documentation_url
let documentationMessage: string let documentationMessage: string

View File

@@ -1,4 +1,4 @@
import { globSync } from "glob" import { GlobSync } from "glob";
export interface Globber { export interface Globber {
glob(pattern: string): string[] glob(pattern: string): string[]
@@ -6,6 +6,6 @@ export interface Globber {
export class FileGlobber implements Globber { export class FileGlobber implements Globber {
glob(pattern: string): string[] { glob(pattern: string): string[] {
return globSync(pattern, { mark: true }) return new GlobSync(pattern, { mark: true }).found
} }
} }

View File

@@ -1,8 +1,8 @@
import * as core from "@actions/core" import * as core from '@actions/core';
import { Context } from "@actions/github/lib/context" import {Context} from "@actions/github/lib/context";
import { readFileSync } from "fs" import {readFileSync} from 'fs';
import { ArtifactGlobber } from "./ArtifactGlobber" import {ArtifactGlobber} from './ArtifactGlobber';
import { Artifact } from "./Artifact" import {Artifact} from './Artifact';
export interface Inputs { export interface Inputs {
readonly allowUpdates: boolean readonly allowUpdates: boolean
@@ -15,8 +15,6 @@ export interface Inputs {
readonly createdReleaseName?: string readonly createdReleaseName?: string
readonly discussionCategory?: string readonly discussionCategory?: string
readonly generateReleaseNotes: boolean readonly generateReleaseNotes: boolean
readonly makeLatest?: "legacy" | "true" | "false" | undefined
readonly omitBodyDuringUpdate: boolean
readonly owner: string readonly owner: string
readonly removeArtifacts: boolean readonly removeArtifacts: boolean
readonly replacesArtifacts: boolean readonly replacesArtifacts: boolean
@@ -41,52 +39,53 @@ export class CoreInputs implements Inputs {
} }
get allowUpdates(): boolean { get allowUpdates(): boolean {
const allow = core.getInput("allowUpdates") const allow = core.getInput('allowUpdates')
return allow == "true" return allow == 'true'
} }
get artifacts(): Artifact[] { get artifacts(): Artifact[] {
let artifacts = core.getInput("artifacts") let artifacts = core.getInput('artifacts')
if (!artifacts) { if (!artifacts) {
artifacts = core.getInput("artifact") artifacts = core.getInput('artifact')
} }
if (artifacts) { if (artifacts) {
let contentType = core.getInput("artifactContentType") let contentType = core.getInput('artifactContentType')
if (!contentType) { if (!contentType) {
contentType = "raw" contentType = 'raw'
} }
return this.artifactGlobber.globArtifactString(artifacts, contentType, this.artifactErrorsFailBuild) return this.artifactGlobber
.globArtifactString(artifacts, contentType, this.artifactErrorsFailBuild)
} }
return [] return []
} }
get artifactErrorsFailBuild(): boolean { get artifactErrorsFailBuild(): boolean {
const allow = core.getInput("artifactErrorsFailBuild") const allow = core.getInput('artifactErrorsFailBuild')
return allow == "true" return allow == 'true'
} }
private get body(): string | undefined { private get body(): string | undefined {
const body = core.getInput("body") const body = core.getInput('body')
if (body) { if (body) {
return body return body
} }
const bodyFile = core.getInput("bodyFile") const bodyFile = core.getInput('bodyFile')
if (bodyFile) { if (bodyFile) {
return this.stringFromFile(bodyFile) return this.stringFromFile(bodyFile)
} }
return "" return ''
} }
get createdDraft(): boolean { get createdDraft(): boolean {
const draft = core.getInput("draft") const draft = core.getInput('draft')
return draft == "true" return draft == 'true'
} }
get createdPrerelease(): boolean { get createdPrerelease(): boolean {
const preRelease = core.getInput("prerelease") const preRelease = core.getInput('prerelease')
return preRelease == "true" return preRelease == 'true'
} }
get createdReleaseBody(): string | undefined { get createdReleaseBody(): string | undefined {
@@ -95,7 +94,7 @@ export class CoreInputs implements Inputs {
} }
private static get omitBody(): boolean { private static get omitBody(): boolean {
return core.getInput("omitBody") == "true" return core.getInput('omitBody') == 'true'
} }
get createdReleaseName(): string | undefined { get createdReleaseName(): string | undefined {
@@ -104,11 +103,11 @@ export class CoreInputs implements Inputs {
} }
private static get omitName(): boolean { private static get omitName(): boolean {
return core.getInput("omitName") == "true" return core.getInput('omitName') == 'true'
} }
get commit(): string | undefined { get commit(): string | undefined {
const commit = core.getInput("commit") const commit = core.getInput('commit')
if (commit) { if (commit) {
return commit return commit
} }
@@ -116,7 +115,7 @@ export class CoreInputs implements Inputs {
} }
get discussionCategory(): string | undefined { get discussionCategory(): string | undefined {
const category = core.getInput("discussionCategory") const category = core.getInput('discussionCategory')
if (category) { if (category) {
return category return category
} }
@@ -124,48 +123,38 @@ export class CoreInputs implements Inputs {
} }
private get name(): string | undefined { private get name(): string | undefined {
const name = core.getInput("name") const name = core.getInput('name')
if (name) { if (name) {
return name return name
} }
return this.tag return this.tag
} }
get generateReleaseNotes(): boolean { get generateReleaseNotes(): boolean {
const generate = core.getInput("generateReleaseNotes") const generate = core.getInput('generateReleaseNotes')
return generate == "true" return generate == 'true'
}
get makeLatest(): "legacy" | "true" | "false" | undefined {
let latest = core.getInput("makeLatest")
if (latest == "true" || latest == "false" || latest == "legacy") {
return latest
}
return undefined
} }
get owner(): string { get owner(): string {
let owner = core.getInput("owner") let owner = core.getInput('owner')
if (owner) { if (owner) {
return owner return owner
} }
return this.context.repo.owner return this.context.repo.owner
} }
get removeArtifacts(): boolean { get removeArtifacts(): boolean {
const removes = core.getInput("removeArtifacts") const removes = core.getInput('removeArtifacts')
return removes == "true" return removes == 'true'
} }
get replacesArtifacts(): boolean { get replacesArtifacts(): boolean {
const replaces = core.getInput("replacesArtifacts") const replaces = core.getInput('replacesArtifacts')
return replaces == "true" return replaces == 'true'
} }
get repo(): string { get repo(): string {
let repo = core.getInput("repo") let repo = core.getInput('repo')
if (repo) { if (repo) {
return repo return repo
} }
@@ -175,11 +164,11 @@ export class CoreInputs implements Inputs {
get skipIfReleaseExists(): boolean { get skipIfReleaseExists(): boolean {
return core.getBooleanInput("skipIfReleaseExists") return core.getBooleanInput("skipIfReleaseExists")
} }
get tag(): string { get tag(): string {
const tag = core.getInput("tag") const tag = core.getInput('tag')
if (tag) { if (tag) {
return tag return tag;
} }
const ref = this.context.ref const ref = this.context.ref
@@ -192,7 +181,7 @@ export class CoreInputs implements Inputs {
} }
get token(): string { get token(): string {
return core.getInput("token", { required: true }) return core.getInput('token', {required: true})
} }
get updatedDraft(): boolean | undefined { get updatedDraft(): boolean | undefined {
@@ -201,16 +190,16 @@ export class CoreInputs implements Inputs {
} }
private static get omitDraftDuringUpdate(): boolean { private static get omitDraftDuringUpdate(): boolean {
return core.getInput("omitDraftDuringUpdate") == "true" return core.getInput('omitDraftDuringUpdate') == 'true'
} }
get updatedPrerelease(): boolean | undefined { get updatedPrerelease(): boolean | undefined {
if (CoreInputs.omitPrereleaseDuringUpdate) return undefined if (CoreInputs.omitPrereleaseDuringUpdate) return undefined
return this.createdPrerelease return this.createdPrerelease
} }
private static get omitPrereleaseDuringUpdate(): boolean { private static get omitPrereleaseDuringUpdate(): boolean {
return core.getInput("omitPrereleaseDuringUpdate") == "true" return core.getInput('omitPrereleaseDuringUpdate') == 'true'
} }
get updatedReleaseBody(): string | undefined { get updatedReleaseBody(): string | undefined {
@@ -218,28 +207,24 @@ export class CoreInputs implements Inputs {
return this.body return this.body
} }
get updateOnlyUnreleased(): boolean { private static get omitBodyDuringUpdate(): boolean {
return core.getInput("updateOnlyUnreleased") == "true" return core.getInput('omitBodyDuringUpdate') == 'true'
} }
get updatedReleaseName(): string | undefined { get updatedReleaseName(): string | undefined {
if (CoreInputs.omitName || CoreInputs.omitNameDuringUpdate) return undefined if (CoreInputs.omitName || CoreInputs.omitNameDuringUpdate) return undefined
return this.name return this.name
} }
private static get omitBodyDuringUpdate(): boolean { get updateOnlyUnreleased(): boolean {
return core.getInput("omitBodyDuringUpdate") == "true" return core.getInput('updateOnlyUnreleased') == 'true'
}
get omitBodyDuringUpdate(): boolean {
return CoreInputs.omitBodyDuringUpdate
} }
private static get omitNameDuringUpdate(): boolean { private static get omitNameDuringUpdate(): boolean {
return core.getInput("omitNameDuringUpdate") == "true" return core.getInput('omitNameDuringUpdate') == 'true'
} }
stringFromFile(path: string): string { stringFromFile(path: string): string {
return readFileSync(path, "utf-8") return readFileSync(path, 'utf-8')
} }
} }

View File

@@ -1,14 +1,14 @@
import * as github from "@actions/github" import * as github from '@actions/github';
import * as core from "@actions/core" import * as core from '@actions/core';
import { CoreInputs } from "./Inputs" import {CoreInputs} from './Inputs';
import { GithubReleases } from "./Releases" import {GithubReleases} from './Releases';
import { Action } from "./Action" import {Action} from './Action';
import { GithubArtifactUploader } from "./ArtifactUploader" import {GithubArtifactUploader} from './ArtifactUploader';
import { FileArtifactGlobber } from "./ArtifactGlobber" import {FileArtifactGlobber} from './ArtifactGlobber';
import { GithubError } from "./GithubError" import {GithubError} from './GithubError';
import { CoreOutputs } from "./Outputs" import {CoreOutputs} from "./Outputs";
import { GithubArtifactDestroyer } from "./ArtifactDestroyer" import {GithubArtifactDestroyer} from "./ArtifactDestroyer";
import { ActionSkipper, ReleaseActionSkipper } from "./ActionSkipper" import {ActionSkipper, ReleaseActionSkipper} from "./ActionSkipper";
async function run() { async function run() {
try { try {
@@ -16,12 +16,12 @@ async function run() {
await action.perform() await action.perform()
} catch (error) { } catch (error) {
const githubError = new GithubError(error) const githubError = new GithubError(error)
core.setFailed(githubError.toString()) core.setFailed(githubError.toString());
} }
} }
function createAction(): Action { function createAction(): Action {
const token = core.getInput("token") const token = core.getInput('token')
const context = github.context const context = github.context
const git = github.getOctokit(token) const git = github.getOctokit(token)
const globber = new FileArtifactGlobber() const globber = new FileArtifactGlobber()
@@ -32,8 +32,8 @@ function createAction(): Action {
const skipper = new ReleaseActionSkipper(inputs.skipIfReleaseExists, releases, inputs.tag) const skipper = new ReleaseActionSkipper(inputs.skipIfReleaseExists, releases, inputs.tag)
const uploader = new GithubArtifactUploader(releases, inputs.replacesArtifacts, inputs.artifactErrorsFailBuild) const uploader = new GithubArtifactUploader(releases, inputs.replacesArtifacts, inputs.artifactErrorsFailBuild)
const artifactDestroyer = new GithubArtifactDestroyer(releases) const artifactDestroyer = new GithubArtifactDestroyer(releases)
return new Action(inputs, outputs, releases, uploader, artifactDestroyer, skipper) return new Action(inputs, outputs, releases, uploader, artifactDestroyer, skipper)
} }
run() run();

View File

@@ -1,22 +1,14 @@
import * as core from "@actions/core" import * as core from '@actions/core';
import { ReleaseData } from "./Releases" import {ReleaseData} from "./Releases";
export interface Outputs { export interface Outputs {
applyReleaseData(releaseData: ReleaseData): void applyReleaseData(releaseData: ReleaseData): void
applyAssetUrls(assetUrls: Record<string, string>): void
} }
export class CoreOutputs implements Outputs { export class CoreOutputs implements Outputs {
applyReleaseData(releaseData: ReleaseData) { applyReleaseData(releaseData: ReleaseData) {
core.setOutput("id", releaseData.id) core.setOutput('id', releaseData.id)
core.setOutput("html_url", releaseData.html_url) core.setOutput('html_url', releaseData.html_url)
core.setOutput("upload_url", releaseData.upload_url) core.setOutput('upload_url', releaseData.upload_url)
core.setOutput("tarball_url", releaseData.tarball_url || "")
core.setOutput("zipball_url", releaseData.zipball_url || "")
} }
}
applyAssetUrls(assetUrls: Record<string, string>) {
const assetUrlsJson = JSON.stringify(assetUrls)
core.setOutput("assets", assetUrlsJson)
}
}

View File

@@ -1,7 +1,7 @@
import path from "path" import path from "path";
export class PathNormalizer { export class PathNormalizer {
static normalizePath(pathString: string): string { static normalizePath(pathString: string): string {
return pathString.split(path.sep).join("/") return pathString.split(path.sep).join("/")
} }
} }

View File

@@ -1,5 +1,6 @@
export class ReleaseValidator { export class ReleaseValidator {
constructor(private updateOnlyUnreleased: boolean) {} constructor(private updateOnlyUnreleased: boolean) {
}
validateReleaseUpdate(releaseResponse: ReleaseStageArguments) { validateReleaseUpdate(releaseResponse: ReleaseStageArguments) {
if (!this.updateOnlyUnreleased) { if (!this.updateOnlyUnreleased) {
@@ -7,9 +8,7 @@ export class ReleaseValidator {
} }
if (!releaseResponse.draft && !releaseResponse.prerelease) { if (!releaseResponse.draft && !releaseResponse.prerelease) {
throw new Error( throw new Error(`Tried to update "${releaseResponse.name ?? "release"}" which is neither a draft or prerelease. (updateOnlyUnreleased is on)`)
`Tried to update "${releaseResponse.name ?? "release"}" which is neither a draft or prerelease. (updateOnlyUnreleased is on)`
)
} }
} }
} }
@@ -18,4 +17,4 @@ export type ReleaseStageArguments = {
draft: boolean draft: boolean
name: string | null name: string | null
prerelease: boolean prerelease: boolean
} }

View File

@@ -1,7 +1,7 @@
import type { GitHub } from "@actions/github/lib/utils" import {GitHub} from '@actions/github/lib/utils'
import type { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods" import {OctokitResponse} from "@octokit/types";
import type { OctokitResponse } from "@octokit/types" import {RestEndpointMethodTypes} from "@octokit/plugin-rest-endpoint-methods";
import type { Inputs } from "./Inputs" import {Inputs} from "./Inputs";
export type CreateReleaseResponse = RestEndpointMethodTypes["repos"]["createRelease"]["response"] export type CreateReleaseResponse = RestEndpointMethodTypes["repos"]["createRelease"]["response"]
export type ReleaseByTagResponse = RestEndpointMethodTypes["repos"]["getReleaseByTag"]["response"] export type ReleaseByTagResponse = RestEndpointMethodTypes["repos"]["getReleaseByTag"]["response"]
@@ -10,14 +10,11 @@ export type ListReleaseAssetsResponseData = RestEndpointMethodTypes["repos"]["li
export type UpdateReleaseResponse = RestEndpointMethodTypes["repos"]["updateRelease"]["response"] export type UpdateReleaseResponse = RestEndpointMethodTypes["repos"]["updateRelease"]["response"]
export type UploadArtifactResponse = RestEndpointMethodTypes["repos"]["uploadReleaseAsset"]["response"] export type UploadArtifactResponse = RestEndpointMethodTypes["repos"]["uploadReleaseAsset"]["response"]
export type CreateOrUpdateReleaseResponse = CreateReleaseResponse | UpdateReleaseResponse export type CreateOrUpdateReleaseResponse = CreateReleaseResponse | UpdateReleaseResponse
export type GenerateReleaseNotesResponse = RestEndpointMethodTypes["repos"]["generateReleaseNotes"]["response"]
export type ReleaseData = { export type ReleaseData = {
id: number id: number
html_url: string html_url: string
upload_url: string upload_url: string
tarball_url: string | null
zipball_url: string | null
} }
export interface Releases { export interface Releases {
@@ -28,7 +25,6 @@ export interface Releases {
discussionCategory?: string, discussionCategory?: string,
draft?: boolean, draft?: boolean,
generateReleaseNotes?: boolean, generateReleaseNotes?: boolean,
makeLatest?: "legacy" | "true" | "false" | undefined,
name?: string, name?: string,
prerelease?: boolean prerelease?: boolean
): Promise<CreateReleaseResponse> ): Promise<CreateReleaseResponse>
@@ -37,8 +33,6 @@ export interface Releases {
getByTag(tag: string): Promise<ReleaseByTagResponse> getByTag(tag: string): Promise<ReleaseByTagResponse>
generateReleaseNotes(tag: string): Promise<GenerateReleaseNotesResponse>
listArtifactsForRelease(releaseId: number): Promise<ListReleaseAssetsResponseData> listArtifactsForRelease(releaseId: number): Promise<ListReleaseAssetsResponseData>
listReleases(): Promise<ListReleasesResponse> listReleases(): Promise<ListReleasesResponse>
@@ -50,7 +44,6 @@ export interface Releases {
commitHash?: string, commitHash?: string,
discussionCategory?: string, discussionCategory?: string,
draft?: boolean, draft?: boolean,
makeLatest?: "legacy" | "true" | "false" | undefined,
name?: string, name?: string,
prerelease?: boolean prerelease?: boolean
): Promise<UpdateReleaseResponse> ): Promise<UpdateReleaseResponse>
@@ -61,7 +54,7 @@ export interface Releases {
contentType: string, contentType: string,
file: string | object, file: string | object,
name: string, name: string,
releaseId: number releaseId: number,
): Promise<UploadArtifactResponse> ): Promise<UploadArtifactResponse>
} }
@@ -81,7 +74,6 @@ export class GithubReleases implements Releases {
discussionCategory?: string, discussionCategory?: string,
draft?: boolean, draft?: boolean,
generateReleaseNotes?: boolean, generateReleaseNotes?: boolean,
makeLatest?: "legacy" | "true" | "false" | undefined,
name?: string, name?: string,
prerelease?: boolean prerelease?: boolean
): Promise<CreateReleaseResponse> { ): Promise<CreateReleaseResponse> {
@@ -92,28 +84,21 @@ export class GithubReleases implements Releases {
discussion_category_name: discussionCategory, discussion_category_name: discussionCategory,
draft: draft, draft: draft,
generate_release_notes: generateReleaseNotes, generate_release_notes: generateReleaseNotes,
make_latest: makeLatest,
owner: this.inputs.owner, owner: this.inputs.owner,
prerelease: prerelease, prerelease: prerelease,
repo: this.inputs.repo, repo: this.inputs.repo,
target_commitish: commitHash, target_commitish: commitHash,
tag_name: tag, tag_name: tag
}) })
} }
async deleteArtifact(assetId: number): Promise<OctokitResponse<any>> { async deleteArtifact(
assetId: number
): Promise<OctokitResponse<any>> {
return this.git.rest.repos.deleteReleaseAsset({ return this.git.rest.repos.deleteReleaseAsset({
asset_id: assetId, asset_id: assetId,
owner: this.inputs.owner, owner: this.inputs.owner,
repo: this.inputs.repo, repo: this.inputs.repo
})
}
async generateReleaseNotes(tag: string): Promise<GenerateReleaseNotesResponse> {
return this.git.rest.repos.generateReleaseNotes({
owner: this.inputs.owner,
repo: this.inputs.repo,
tag_name: tag,
}) })
} }
@@ -121,22 +106,24 @@ export class GithubReleases implements Releases {
return this.git.rest.repos.getReleaseByTag({ return this.git.rest.repos.getReleaseByTag({
owner: this.inputs.owner, owner: this.inputs.owner,
repo: this.inputs.repo, repo: this.inputs.repo,
tag: tag, tag: tag
}) })
} }
async listArtifactsForRelease(releaseId: number): Promise<ListReleaseAssetsResponseData> { async listArtifactsForRelease(
releaseId: number
): Promise<ListReleaseAssetsResponseData> {
return this.git.paginate(this.git.rest.repos.listReleaseAssets, { return this.git.paginate(this.git.rest.repos.listReleaseAssets, {
owner: this.inputs.owner, owner: this.inputs.owner,
release_id: releaseId, release_id: releaseId,
repo: this.inputs.repo, repo: this.inputs.repo
}) })
} }
async listReleases(): Promise<ListReleasesResponse> { async listReleases(): Promise<ListReleasesResponse> {
return this.git.rest.repos.listReleases({ return this.git.rest.repos.listReleases({
owner: this.inputs.owner, owner: this.inputs.owner,
repo: this.inputs.repo, repo: this.inputs.repo
}) })
} }
@@ -147,7 +134,6 @@ export class GithubReleases implements Releases {
commitHash?: string, commitHash?: string,
discussionCategory?: string, discussionCategory?: string,
draft?: boolean, draft?: boolean,
makeLatest?: "legacy" | "true" | "false" | undefined,
name?: string, name?: string,
prerelease?: boolean prerelease?: boolean
): Promise<UpdateReleaseResponse> { ): Promise<UpdateReleaseResponse> {
@@ -158,12 +144,11 @@ export class GithubReleases implements Releases {
name: name, name: name,
discussion_category_name: discussionCategory, discussion_category_name: discussionCategory,
draft: draft, draft: draft,
make_latest: makeLatest,
owner: this.inputs.owner, owner: this.inputs.owner,
prerelease: prerelease, prerelease: prerelease,
repo: this.inputs.repo, repo: this.inputs.repo,
target_commitish: commitHash, target_commitish: commitHash,
tag_name: tag, tag_name: tag
}) })
} }
@@ -173,19 +158,19 @@ export class GithubReleases implements Releases {
contentType: string, contentType: string,
file: string | object, file: string | object,
name: string, name: string,
releaseId: number releaseId: number,
): Promise<UploadArtifactResponse> { ): Promise<UploadArtifactResponse> {
return this.git.rest.repos.uploadReleaseAsset({ return this.git.rest.repos.uploadReleaseAsset({
url: assetUrl, url: assetUrl,
headers: { headers: {
"content-length": contentLength, "content-length": contentLength,
"content-type": contentType, "content-type": contentType
}, },
data: file as any, data: file as any,
name: name, name: name,
owner: this.inputs.owner, owner: this.inputs.owner,
release_id: releaseId, release_id: releaseId,
repo: this.inputs.repo, repo: this.inputs.repo
}) })
} }
} }

View File

@@ -1,13 +1,13 @@
{ {
"compilerOptions": { "compilerOptions": {
"target": "ES2022", "target": "es2015", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
"module": "NodeNext", "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
"moduleResolution": "NodeNext", "moduleResolution": "node",
"outDir": "./lib", "outDir": "./lib", /* Redirect output structure to the directory. */
"strict": true, "rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
"skipLibCheck": true, "strict": true, /* Enable all strict type-checking options. */
"noImplicitAny": true, "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
"esModuleInterop": true "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
}, },
"exclude": ["node_modules", "**/*.test.ts"] "exclude": ["node_modules", "**/*.test.ts"]
} }

2300
yarn.lock

File diff suppressed because it is too large Load Diff