Merge pull request #125 from svenstaro/dependabot/npm_and_yarn/braces-3.0.3

Bump braces from 3.0.2 to 3.0.3

.eslintrc.json

@@ -24,6 +24,7 @@
         "@typescript-eslint/func-call-spacing": ["error", "never"],
         "@typescript-eslint/no-array-constructor": "error",
         "@typescript-eslint/no-empty-interface": "error",
+        "@typescript-eslint/no-explicit-any": "off",
         "@typescript-eslint/no-extraneous-class": "error",
         "@typescript-eslint/no-for-in-array": "error",
         "@typescript-eslint/no-inferrable-types": "error",

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [2.9.0] - 2024-02-22
+- Allow seeting a release as draft [#112](https://github.com/svenstaro/upload-release-action/pull/112) (thanks @ShonP40)
+
+## [2.8.0] - 2024-02-21
+- Bump all deps
+- Update to node 20
+
+## [2.7.0] - 2023-07-28
+- Allow setting an explicit target_commitish [#46](https://github.com/svenstaro/upload-release-action/pull/46) (thanks @Spikatrix)
+
+## [2.6.1] - 2023-05-31
+- Do not overwrite body or name if empty [#108](https://github.com/svenstaro/upload-release-action/pull/108) (thanks @regevbr)
+
 ## [2.6.0] - 2023-05-23
 - Add `make_latest` input parameter. Can be set to `false` to prevent the created release from being marked as the latest release for the repository [#100](https://github.com/svenstaro/upload-release-action/pull/100) (thanks @brandonkelly)
 - Don't try to upload empty files [#102](https://github.com/svenstaro/upload-release-action/pull/102) (thanks @Loyalsoldier)

README.md

@@ -18,9 +18,11 @@ Optional Arguments
 - `file_glob`: If set to true, the `file` argument can be a glob pattern (`asset_name` is ignored in this case) (Default: `false`)
 - `overwrite`: If an asset with the same name already exists, overwrite it (Default: `false`).
 - `promote`: If a prerelease already exists, promote it to a release (Default: `false`).
+- `draft`: Sets the release as a draft instead of publishing it, allowing you to make any edits needed before releasing (Default: `false`).
 - `prerelease`: Mark the release as a pre-release (Default: `false`).
 - `make_latest`: Mark the release as the latest release for the repository (Default: `true`).
 - `release_name`: Explicitly set a release name. (Defaults: implicitly same as `tag` via GitHub API).
+- `target_commit`: Sets the commit hash or branch for the tag to be based on (Default: the default branch, usually `main`).
 - `body`: Content of the release text (Default: `""`).
 - `repo_name`: Specify the name of the GitHub repository in which the GitHub release will be created, edited, and deleted. If the repository is other than the current, it is required to create a personal access token with `repo`, `user`, `admin:repo_hook` scopes to the foreign repository and add it as a secret. (Default: current repository).
 
@@ -224,6 +226,7 @@ To release this Action:
 
 - Bump version in `package.json`
 - Create `CHANGELOG.md` entry
+- `npm update`
 - `npm run all`
 - `git commit -am <version>`
 - `git tag -sm <version> <version>`

action.yml

@@ -24,6 +24,8 @@ inputs:
     description: 'Promote a prerelease to release. Defaults to "false".'
   file_glob:
     description: 'If true the file can be a glob pattern, asset_name is ignored if this is true.'
+  draft:
+    description: 'Mark the release as a draft. Defaults to "false".'
   prerelease:
     description: 'Mark the release as a pre-release. Defaults to "false".'
   make_latest:
@@ -32,11 +34,13 @@ inputs:
     description: 'Explicitly set a release name. Defaults to empty which will cause the release to take the tag as name on GitHub.'
   body:
     description: 'Content of the release text. Empty by default.'
+  target_commit:
+    description: 'Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository\"s default branch (usually `main`).'
   repo_name:
     description: 'Specify the name of the GitHub repository in which the GitHub release will be created, edited, and deleted. If the repository is other than the current, it is required to create a personal access token with `repo`, `user`, `admin:repo_hook` scopes to the foreign repository and add it as a secret. Defaults to the current repository'
 outputs:
   browser_download_url:
     description: 'The publicly available URL of the asset.'
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "upload-release-action",
-  "version": "2.6.0",
+  "version": "2.9.0",
   "private": true,
   "description": "Upload files to a GitHub release",
   "main": "lib/main.js",
@@ -27,26 +27,26 @@
   "author": "Sven-Hendrik Haase",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.10.0",
-    "@actions/github": "^5.1.1",
+    "@actions/core": "^1.10.1",
+    "@actions/github": "^6.0.0",
     "@lifeomic/attempt": "^3.0.3",
-    "@octokit/core": "^4.2.1",
+    "@octokit/core": "^5.1.0",
     "glob": "^10"
   },
   "devDependencies": {
-    "@octokit/types": "^9.2.3",
-    "@types/glob": "^8",
+    "@octokit/types": "^12.5.0",
     "@types/jest": "^29",
-    "@types/node": "^16",
-    "@typescript-eslint/parser": "^5",
-    "@vercel/ncc": "^0.36.1",
+    "@types/node": "^20",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/parser": "^7",
+    "@vercel/ncc": "^0.38.1",
     "eslint": "^8",
-    "eslint-plugin-github": "^4.7",
+    "eslint-plugin-github": "^4.10",
     "eslint-plugin-jest": "^27",
     "jest": "^29",
     "jest-circus": "^29",
     "js-yaml": "^4",
-    "prettier": "^2.8",
+    "prettier": "^3.2",
     "ts-jest": "^29",
     "typescript": "^5"
   }

src/main.ts

@@ -7,6 +7,7 @@ import * as path from 'path'
 import * as glob from 'glob'
 import {retry} from '@lifeomic/attempt'
 
+const getRef = 'GET /repos/{owner}/{repo}/git/ref/{ref}' as const
 const releaseByTag = 'GET /repos/{owner}/{repo}/releases/tags/{tag}' as const
 const createRelease = 'POST /repos/{owner}/{repo}/releases' as const
 const updateRelease =
@@ -27,13 +28,15 @@ type UpdateReleaseParams = Endpoints[typeof updateRelease]['parameters']
 
 async function get_release_by_tag(
   tag: string,
+  draft: boolean,
   prerelease: boolean,
   make_latest: boolean,
   release_name: string,
   body: string,
   octokit: Octokit,
   overwrite: boolean,
-  promote: boolean
+  promote: boolean,
+  target_commit: string
 ): Promise<ReleaseByTagResp | CreateReleaseResp | UpdateReleaseResp> {
   let release: ReleaseByTagResp
   try {
@@ -48,13 +51,30 @@ async function get_release_by_tag(
       core.debug(
         `Release for tag ${tag} doesn't exist yet so we'll create it now.`
       )
+      if (target_commit) {
+        try {
+          await octokit.request(getRef, {
+            ...repo(),
+            ref: `tags/${tag}`
+          })
+          core.warning(
+            `Ignoring target_commit as the tag ${tag} already exists`
+          )
+        } catch (tagError: any) {
+          if (tagError.status !== 404) {
+            throw tagError
+          }
+        }
+      }
       return await octokit.request(createRelease, {
         ...repo(),
         tag_name: tag,
+        draft: draft,
         prerelease: prerelease,
         make_latest: make_latest ? 'true' : 'false',
         name: release_name,
-        body: body
+        body: body,
+        target_commitish: target_commit
       })
     } else {
       throw error
@@ -67,14 +87,14 @@ async function get_release_by_tag(
     updateObject.prerelease = false
   }
   if (overwrite) {
-    if (release.data.name !== release_name) {
+    if (release_name && release.data.name !== release_name) {
       core.debug(
         `The ${tag} release already exists with a different name ${release.data.name} so we'll overwrite it.`
       )
       updateObject = updateObject || {}
       updateObject.name = release_name
     }
-    if (release.data.body !== body) {
+    if (body && release.data.body !== body) {
       core.debug(
         `The ${tag} release already exists with a different body ${release.data.body} so we'll overwrite it.`
       )
@@ -191,9 +211,11 @@ async function run(): Promise<void> {
     const file_glob = core.getInput('file_glob') == 'true' ? true : false
     const overwrite = core.getInput('overwrite') == 'true' ? true : false
     const promote = core.getInput('promote') == 'true' ? true : false
+    const draft = core.getInput('draft') == 'true' ? true : false
     const prerelease = core.getInput('prerelease') == 'true' ? true : false
     const make_latest = core.getInput('make_latest') != 'false' ? true : false
     const release_name = core.getInput('release_name')
+    const target_commit = core.getInput('target_commit')
     const body = core
       .getInput('body')
       .replace(/%0A/gi, '\n')
@@ -203,13 +225,15 @@ async function run(): Promise<void> {
     const octokit = github.getOctokit(token)
     const release = await get_release_by_tag(
       tag,
+      draft,
       prerelease,
       make_latest,
       release_name,
       body,
       octokit,
       overwrite,
-      promote
+      promote,
+      target_commit
     )
 
     if (file_glob) {