2.7.0

Allow setting an explicit target_commitish

.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,7 +1,10 @@
 # Changelog
 
+## [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)
+- 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)

README.md

@@ -21,6 +21,7 @@ Optional Arguments
 - `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).
 

action.yml

@@ -32,6 +32,8 @@ 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:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "upload-release-action",
-  "version": "2.6.1",
+  "version": "2.7.0",
   "private": true,
   "description": "Upload files to a GitHub release",
   "main": "lib/main.js",
@@ -38,15 +38,15 @@
     "@types/glob": "^8",
     "@types/jest": "^29",
     "@types/node": "^16",
-    "@typescript-eslint/parser": "^5",
+    "@typescript-eslint/parser": "^6",
     "@vercel/ncc": "^0.36.1",
     "eslint": "^8",
-    "eslint-plugin-github": "^4.7",
+    "eslint-plugin-github": "^4.9",
     "eslint-plugin-jest": "^27",
     "jest": "^29",
     "jest-circus": "^29",
     "js-yaml": "^4",
-    "prettier": "^2.8",
+    "prettier": "^3.0",
     "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 =
@@ -33,7 +34,8 @@ async function get_release_by_tag(
   body: string,
   octokit: Octokit,
   overwrite: boolean,
-  promote: boolean
+  promote: boolean,
+  target_commit: string
 ): Promise<ReleaseByTagResp | CreateReleaseResp | UpdateReleaseResp> {
   let release: ReleaseByTagResp
   try {
@@ -48,13 +50,29 @@ 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,
         prerelease: prerelease,
         make_latest: make_latest ? 'true' : 'false',
         name: release_name,
-        body: body
+        body: body,
+        target_commitish: target_commit
       })
     } else {
       throw error
@@ -194,6 +212,7 @@ async function run(): Promise<void> {
     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')
@@ -209,7 +228,8 @@ async function run(): Promise<void> {
       body,
       octokit,
       overwrite,
-      promote
+      promote,
+      target_commit
     )
 
     if (file_glob) {