feat!: add support for uploading to release drafts
When we try to get a release by tag, it doesn't return release drafts. In order to get release drafts we need to list the releases using a token that has write access on the repo. Also added tests for the same. BREAKING CHANGE: Changed behaviour to not create a new release. Only upload to existing releases. Also updated the action inputs to reflect the same. Signed-off-by: Harikrishnan Balagopal <harikrishmenon@gmail.com>
This commit is contained in:
Harikrishnan Balagopal
131
src/main.ts
131
src/main.ts
@@ -1,60 +1,82 @@
|
||||
import * as fs from 'fs'
|
||||
import {Octokit} from '@octokit/core'
|
||||
import {Endpoints} from '@octokit/types'
|
||||
import {
|
||||
Endpoints,
|
||||
ReposGetReleaseByTagResponseData,
|
||||
ReposListReleasesResponseData
|
||||
} from '@octokit/types'
|
||||
import * as core from '@actions/core'
|
||||
import * as github from '@actions/github'
|
||||
import * as path from 'path'
|
||||
import * as glob from 'glob'
|
||||
|
||||
type GetReleaseByTagResp = Endpoints['GET /repos/:owner/:repo/releases/tags/:tag']['response']
|
||||
type ListReleasesResp = Endpoints['GET /repos/:owner/:repo/releases']['response']
|
||||
type RepoAssetsResp = Endpoints['GET /repos/:owner/:repo/releases/:release_id/assets']['response']
|
||||
type ReleaseByTagResp = Endpoints['GET /repos/:owner/:repo/releases/tags/:tag']['response']
|
||||
type CreateReleaseResp = Endpoints['POST /repos/:owner/:repo/releases']['response']
|
||||
type UploadAssetResp = Endpoints['POST /repos/:owner/:repo/releases/:release_id/assets{?name,label}']['response']
|
||||
|
||||
type ReleaseData =
|
||||
| ReposGetReleaseByTagResponseData
|
||||
| ReposListReleasesResponseData[0]
|
||||
async function get_release_by_tag(
|
||||
tag: string,
|
||||
prerelease: boolean,
|
||||
release_name: string,
|
||||
body: string,
|
||||
octokit: Octokit
|
||||
): Promise<ReleaseByTagResp | CreateReleaseResp> {
|
||||
): Promise<ReleaseData> {
|
||||
try {
|
||||
core.debug(`Getting release by tag ${tag}.`)
|
||||
return await octokit.repos.getReleaseByTag({
|
||||
core.info(`Getting release by tag ${tag}`)
|
||||
const resp: GetReleaseByTagResp = await octokit.repos.getReleaseByTag({
|
||||
...repo(),
|
||||
tag: tag
|
||||
})
|
||||
core.debug(`response from get release by tag: ${JSON.stringify(resp)}`)
|
||||
return resp.data
|
||||
} catch (error) {
|
||||
// If this returns 404, we need to create the release first.
|
||||
if (error.status === 404) {
|
||||
core.debug(
|
||||
`Release for tag ${tag} doesn't exist yet so we'll create it now.`
|
||||
)
|
||||
return await octokit.repos.createRelease({
|
||||
...repo(),
|
||||
tag_name: tag,
|
||||
prerelease: prerelease,
|
||||
name: release_name,
|
||||
body: body
|
||||
})
|
||||
} else {
|
||||
if (error.status !== 404) {
|
||||
core.info(`Failed to get release by tag. Not a 404 error. Throwing.`)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
// If we get a 404, we need to check the release drafts.
|
||||
|
||||
try {
|
||||
core.info(
|
||||
'Failed to get release by tag. Checking to see if a release draft with the tag exists.'
|
||||
)
|
||||
const resp: ListReleasesResp = await octokit.repos.listReleases(repo())
|
||||
core.debug(`response from listing releases: ${JSON.stringify(resp)}`)
|
||||
let found = false
|
||||
let draftRelease = resp.data[0]
|
||||
for (const release of resp.data) {
|
||||
if (release.tag_name === tag) {
|
||||
draftRelease = release
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if (found) {
|
||||
core.info('Found release draft with the given tag.')
|
||||
return draftRelease
|
||||
}
|
||||
} catch (error) {
|
||||
core.info(`Failed to list the releases. Throwing.`)
|
||||
throw error
|
||||
}
|
||||
|
||||
throw new Error(`No release or release draft found with the tag ${tag}`)
|
||||
}
|
||||
|
||||
async function upload_to_release(
|
||||
release: ReleaseByTagResp | CreateReleaseResp,
|
||||
releaseData: ReleaseData,
|
||||
file: string,
|
||||
asset_name: string,
|
||||
tag: string,
|
||||
overwrite: boolean,
|
||||
octokit: Octokit
|
||||
): Promise<undefined | string> {
|
||||
): Promise<string> {
|
||||
const stat = fs.statSync(file)
|
||||
if (!stat.isFile()) {
|
||||
core.debug(`Skipping ${file}, since its not a file`)
|
||||
return
|
||||
core.info(`Skipping ${file} since it is not a file.`)
|
||||
return ''
|
||||
}
|
||||
const file_size = stat.size
|
||||
const file_bytes = fs.readFileSync(file)
|
||||
@@ -62,32 +84,32 @@ async function upload_to_release(
|
||||
// Check for duplicates.
|
||||
const assets: RepoAssetsResp = await octokit.repos.listReleaseAssets({
|
||||
...repo(),
|
||||
release_id: release.data.id
|
||||
release_id: releaseData.id
|
||||
})
|
||||
const duplicate_asset = assets.data.find(a => a.name === asset_name)
|
||||
if (duplicate_asset !== undefined) {
|
||||
if (overwrite) {
|
||||
core.debug(
|
||||
`An asset called ${asset_name} already exists in release ${tag} so we'll overwrite it.`
|
||||
core.info(
|
||||
`Overwriting since an asset called ${asset_name} already exists in release ${tag}`
|
||||
)
|
||||
await octokit.repos.deleteReleaseAsset({
|
||||
...repo(),
|
||||
asset_id: duplicate_asset.id
|
||||
})
|
||||
} else {
|
||||
core.setFailed(`An asset called ${asset_name} already exists.`)
|
||||
core.setFailed(
|
||||
`Overwrite is set to false and an asset called ${asset_name} already exists in release ${tag}`
|
||||
)
|
||||
return duplicate_asset.browser_download_url
|
||||
}
|
||||
} else {
|
||||
core.debug(
|
||||
`No pre-existing asset called ${asset_name} found in release ${tag}. All good.`
|
||||
)
|
||||
core.info(`Release ${tag} has no pre-existing asset called ${asset_name}`)
|
||||
}
|
||||
|
||||
core.debug(`Uploading ${file} to ${asset_name} in release ${tag}.`)
|
||||
core.info(`Uploading ${file} to ${asset_name} in release ${tag}`)
|
||||
const uploaded_asset: UploadAssetResp = await octokit.repos.uploadReleaseAsset(
|
||||
{
|
||||
url: release.data.upload_url,
|
||||
url: releaseData.upload_url,
|
||||
name: asset_name,
|
||||
data: file_bytes,
|
||||
headers: {
|
||||
@@ -102,47 +124,38 @@ async function upload_to_release(
|
||||
function repo(): {owner: string; repo: string} {
|
||||
const repo_name = core.getInput('repo_name')
|
||||
// If we're not targeting a foreign repository, we can just return immediately and don't have to do extra work.
|
||||
if (!repo_name) {
|
||||
if (repo_name === '') {
|
||||
return github.context.repo
|
||||
}
|
||||
const owner = repo_name.substr(0, repo_name.indexOf('/'))
|
||||
if (!owner) {
|
||||
throw new Error(`Could not extract 'owner' from 'repo_name': ${repo_name}.`)
|
||||
throw new Error(`Could not extract 'owner' from 'repo_name': ${repo_name}`)
|
||||
}
|
||||
const repo = repo_name.substr(repo_name.indexOf('/') + 1)
|
||||
if (!repo) {
|
||||
throw new Error(`Could not extract 'repo' from 'repo_name': ${repo_name}.`)
|
||||
}
|
||||
return {
|
||||
owner,
|
||||
repo
|
||||
throw new Error(`Could not extract 'repo' from 'repo_name': ${repo_name}`)
|
||||
}
|
||||
return {owner, repo}
|
||||
}
|
||||
|
||||
async function run(): Promise<void> {
|
||||
try {
|
||||
// Get the inputs from the workflow file: https://github.com/actions/toolkit/tree/master/packages/core#inputsoutputs
|
||||
const token = core.getInput('repo_token', {required: true})
|
||||
const file = core.getInput('file', {required: true})
|
||||
const tag = core
|
||||
.getInput('tag', {required: true})
|
||||
.replace('refs/tags/', '')
|
||||
.replace('refs/heads/', '')
|
||||
|
||||
const file_glob = core.getInput('file_glob') == 'true' ? true : false
|
||||
const overwrite = core.getInput('overwrite') == 'true' ? true : false
|
||||
const prerelease = core.getInput('prerelease') == 'true' ? true : false
|
||||
const release_name = core.getInput('release_name')
|
||||
const body = core.getInput('body')
|
||||
const file = core.getInput('file', {required: true})
|
||||
const file_glob = core.getInput('file_glob') === 'true'
|
||||
const asset_name =
|
||||
core.getInput('asset_name') === ''
|
||||
? path.basename(file)
|
||||
: core.getInput('asset_name').replace(/\$tag/g, tag)
|
||||
const overwrite = core.getInput('overwrite') === 'true'
|
||||
|
||||
const octokit: Octokit = github.getOctokit(token)
|
||||
const release = await get_release_by_tag(
|
||||
tag,
|
||||
prerelease,
|
||||
release_name,
|
||||
body,
|
||||
octokit
|
||||
)
|
||||
const release = await get_release_by_tag(tag, octokit)
|
||||
|
||||
if (file_glob) {
|
||||
const files = glob.sync(file)
|
||||
@@ -163,10 +176,6 @@ async function run(): Promise<void> {
|
||||
core.setFailed('No files matching the glob pattern found.')
|
||||
}
|
||||
} else {
|
||||
const asset_name =
|
||||
core.getInput('asset_name') !== ''
|
||||
? core.getInput('asset_name').replace(/\$tag/g, tag)
|
||||
: path.basename(file)
|
||||
const asset_download_url = await upload_to_release(
|
||||
release,
|
||||
file,
|
||||
|
||||
Reference in New Issue
Block a user