feat(github): Add tagNamePrefix option to github publisher options (deprecates vPrefixedTagName) (#9216)

Author: taylorhadden

.changeset/chatty-points-shop.md

@@ -0,0 +1,7 @@
+---
+"app-builder-lib": patch
+"builder-util-runtime": patch
+"electron-publish": patch
+---
+
+feat(github): Add `tagNamePrefix` option and deprecate `vPrefixedTagName`

packages/app-builder-lib/scheme.json

@@ -1603,6 +1603,10 @@
           "default": true,
           "description": "Whether to use `v`-prefixed tag name.",
           "type": "boolean"
+        },
+        "tagNamePrefix": {
+          "description": "Sets the prefix of the tag name that comes before the semver number. Overrides vPrefixedTagName.",
+          "type": "string"
         }
       },
       "required": [

packages/app-builder-lib/src/publish/PublishManager.ts

@@ -5,6 +5,7 @@ import {
   GenericServerOptions,
   getS3LikeProviderBaseUrl,
   GithubOptions,
+  githubTagPrefix,
   githubUrl,
   KeygenOptions,
   Nullish,
@@ -385,7 +386,7 @@ export function computeDownloadUrl(publishConfiguration: PublishConfiguration, f
   let baseUrl
   if (publishConfiguration.provider === "github") {
     const gh = publishConfiguration as GithubOptions
-    baseUrl = `${githubUrl(gh)}/${gh.owner}/${gh.repo}/releases/download/${gh.vPrefixedTagName === false ? "" : "v"}${packager.appInfo.version}`
+    baseUrl = `${githubUrl(gh)}/${gh.owner}/${gh.repo}/releases/download/${githubTagPrefix(gh)}${packager.appInfo.version}`
   } else {
     baseUrl = getS3LikeProviderBaseUrl(publishConfiguration)
   }

packages/builder-util-runtime/src/index.ts

@@ -26,6 +26,7 @@ export {
   getS3LikeProviderBaseUrl,
   GithubOptions,
   githubUrl,
+  githubTagPrefix,
   GitlabOptions,
   KeygenOptions,
   PublishConfiguration,

packages/builder-util-runtime/src/publishOptions.ts

@@ -98,9 +98,17 @@ export interface GithubOptions extends PublishConfiguration {
   /**
    * Whether to use `v`-prefixed tag name.
    * @default true
+   * @deprecated please use #tagNamePrefix instead.
    */
   readonly vPrefixedTagName?: boolean
 
+  /**
+   * If defined, sets the prefix of the tag name that comes before the semver number.
+   * e.g. "v" in "v1.2.3" or "test" of "test1.2.3".
+   * Overrides `vPrefixedTagName`
+   */
+  readonly tagNamePrefix?: string
+
   /**
    * The host (including the port if need).
    * @default github.com
@@ -143,6 +151,16 @@ export function githubUrl(options: GithubOptions, defaultHost = "github.com") {
   return `${options.protocol || "https"}://${options.host || defaultHost}`
 }
 
+export function githubTagPrefix(options: GithubOptions) {
+  if (options.tagNamePrefix) {
+    return options.tagNamePrefix
+  }
+  if (options.vPrefixedTagName ?? true) {
+    return 'v'
+  }
+  return ''
+}
+
 /**
  * [GitLab](https://docs.gitlab.com/ee/user/project/releases/) options.
  *

packages/electron-publish/src/gitHubPublisher.ts

@@ -1,5 +1,5 @@
 import { Arch, Fields, httpExecutor, InvalidConfigurationError, isEmptyOrSpaces, isEnvTrue, isTokenCharValid, log } from "builder-util"
-import { configureRequestOptions, GithubOptions, HttpError, parseJson } from "builder-util-runtime"
+import { configureRequestOptions, GithubOptions, HttpError, parseJson, githubTagPrefix } from "builder-util-runtime"
 import { ClientRequest } from "http"
 import { Lazy } from "lazy-val"
 import * as mime from "mime"
@@ -65,7 +65,7 @@ export class GitHubPublisher extends HttpPublisher {
       throw new InvalidConfigurationError(`Version must not start with "v": ${version}`)
     }
 
-    this.tag = info.vPrefixedTagName === false ? version : `v${version}`
+    this.tag = githubTagPrefix(info) + version
 
     if (isEnvTrue(process.env.EP_DRAFT)) {
       this.releaseType = "draft"