feat(release): add config repository for release (#48)

* feat(release): add config repo for release

* refactor: try to make config and comment clearer

* update TemplateData

* fix: #48 (comment)

* clean comments

---------

Co-authored-by: Northword <[email protected]>

Author: volatile-static

src/config.ts

@@ -61,6 +61,8 @@ function resolveConfig(config: Config): Context {
   config.updateURL = template(config.updateURL, templateData);
   config.xpiDownloadLink = template(config.xpiDownloadLink, templateData);
   config.build.define = mapValues(config.build.define, v => template(v, templateData));
+  config.release.github.repository = template(config.release.github.repository, templateData);
+  config.release.gitee.repository = template(config.release.gitee.repository, templateData);
 
   const hooks = createHooks<Hooks>();
   hooks.addHooks(config.build.hooks);
@@ -155,6 +157,7 @@ const defaultConfig = {
     changelog: "",
     github: {
       enable: "ci",
+      repository: "{{owner}}/{{repo}}",
       updater: "release",
       comment: false,
       releaseNote: (ctx) => {
@@ -163,6 +166,7 @@ const defaultConfig = {
     },
     gitee: {
       enable: "false",
+      repository: "{{owner}}/{{repo}}",
       updater: "release",
       comment: false,
       releaseNote: (ctx) => {

src/core/releaser/base.ts

@@ -20,11 +20,5 @@ export abstract class ReleaseBase extends Base {
     }
   }
 
-  get owner(): string {
-    return this.ctx.templateData.owner;
-  }
-
-  get repo(): string {
-    return this.ctx.templateData.repo;
-  }
+  abstract get remote(): { owner: string; repo: string };
 }

src/core/releaser/gitee.ts

@@ -60,14 +60,12 @@ export default class Gitee extends ReleaseBase {
     prerelease = false,
   ) {
     const old = await this.client.getV5ReposOwnerRepoReleasesTagsTag({
-      owner: this.owner,
-      repo: this.repo,
+      ...this.remote,
       tag,
     });
     if (old?.id) {
       return this.client.patchV5ReposOwnerRepoReleasesId({
-        owner: this.owner,
-        repo: this.repo,
+        ...this.remote,
         name,
         body,
         prerelease,
@@ -76,8 +74,7 @@ export default class Gitee extends ReleaseBase {
       });
     }
     return this.client.postV5ReposOwnerRepoReleases({
-      owner: this.owner,
-      repo: this.repo,
+      ...this.remote,
       name,
       body,
       prerelease,
@@ -89,8 +86,7 @@ export default class Gitee extends ReleaseBase {
   async refreshAttach(releaseId: number, file: string) {
     const assets
         = await this.client.getV5ReposOwnerRepoReleasesReleaseIdAttachFiles({
-          owner: this.owner,
-          repo: this.repo,
+          ...this.remote,
           releaseId,
         });
     const fileBuffer = fs.readFileSync(file);
@@ -99,8 +95,7 @@ export default class Gitee extends ReleaseBase {
       if (asset.name === basename(file)) {
         await this.client
           .deleteV5ReposOwnerRepoReleasesReleaseIdAttachFilesAttachFileId({
-            owner: this.owner,
-            repo: this.repo,
+            ...this.remote,
             releaseId,
             attachFileId: asset.id!,
           })
@@ -109,10 +104,17 @@ export default class Gitee extends ReleaseBase {
       }
     }
     this.client.postV5ReposOwnerRepoReleasesReleaseIdAttachFiles({
-      owner: this.owner,
-      repo: this.repo,
+      ...this.remote,
       releaseId,
       file: new File([fileBuffer], basename(file), { type: "application/octet-stream" }),
     });
   }
+
+  get remote() {
+    const [owner, repo] = this.ctx.release.gitee.repository.split("/");
+    return {
+      owner,
+      repo,
+    };
+  }
 }

src/core/releaser/github.ts

@@ -33,8 +33,7 @@ export default class GitHub extends ReleaseBase {
     const { version, dist, xpiName } = this.ctx;
 
     const release = await this.createRelease({
-      owner: this.owner,
-      repo: this.repo,
+      ...this.remote,
       tag_name: this.ctx.release.bumpp
         .tag!.toString().replaceAll("%s", version),
       name: `Release v${version}`,
@@ -54,8 +53,7 @@ export default class GitHub extends ReleaseBase {
   async getReleaseByTag(tag: string) {
     return await this.client.rest.repos
       .getReleaseByTag({
-        owner: this.owner,
-        repo: this.repo,
+        ...this.remote,
         tag,
       })
       .catch((e) => {
@@ -92,8 +90,7 @@ export default class GitHub extends ReleaseBase {
     this.logger.debug(`Uploading ${asset} to release ${releaseID}`);
     return await this.client.rest.repos
       .uploadReleaseAsset({
-        owner: this.owner,
-        repo: this.repo,
+        ...this.remote,
         release_id: releaseID,
         data: fs.readFileSync(asset) as unknown as string,
         headers: {
@@ -123,8 +120,7 @@ export default class GitHub extends ReleaseBase {
     const release
       = (await this.getReleaseByTag(updater))
       ?? (await this.createRelease({
-        owner: this.owner,
-        repo: this.repo,
+        ...this.remote,
         tag_name: updater,
         prerelease: true,
         make_latest: "false",
@@ -135,8 +131,7 @@ export default class GitHub extends ReleaseBase {
 
     const existAssets = await this.client.rest.repos
       .listReleaseAssets({
-        owner: this.owner,
-        repo: this.repo,
+        ...this.remote,
         release_id: release.id,
       })
       .then((res) => {
@@ -148,8 +143,7 @@ export default class GitHub extends ReleaseBase {
         if (assets.includes(existAsset.name)) {
           this.logger.debug(`Delete existed asset ${existAsset.name} in release ${updater}`);
           await this.client.rest.repos.deleteReleaseAsset({
-            owner: this.owner,
-            repo: this.repo,
+            ...this.remote,
             asset_id: existAsset.id,
           });
         }
@@ -161,8 +155,7 @@ export default class GitHub extends ReleaseBase {
     }
 
     await this.client.rest.repos.updateRelease({
-      owner: this.owner,
-      repo: this.repo,
+      ...this.remote,
       release_id: release.id,
       name: "Release Manifest",
       body: `This release is used to host \`update.json\`, please do not delete or modify it! \n Updated in UTC ${new Date().toISOString()} for version ${version}`,
@@ -188,4 +181,12 @@ export default class GitHub extends ReleaseBase {
 
     return client;
   }
+
+  get remote() {
+    const [owner, repo] = this.ctx.release.github.repository.split("/");
+    return {
+      owner,
+      repo,
+    };
+  }
 }

src/types/config.ts

@@ -85,17 +85,29 @@ export interface Config {
   /**
    * The download link of XPI.
    *
+   * Some placeholders are available, see Context.templateData.
+   *
    * XPI 文件的地址。
    *
+   * 一些可用的占位符请参阅 Context.templateData。
+   *
    * @default `https://github.com/{{owner}}/{{repo}}/release/download/v{{version}}/{{xpiName}}.xpi`
+   *
+   * @see {@link Context.templateData}
    */
   xpiDownloadLink: string;
   /**
    * The uri of update.json.
    *
+   * Some placeholders are available, see Context.templateData.
+   *
    * update.json 文件的地址。
    *
+   * 一些可用的占位符请参阅 Context.templateData。
+   *
    * @default `https://github.com/{{owner}}/{{repo}}/release/download/release/update.json`
+   *
+   * @see {@link Context.templateData}
    */
   updateURL: string;
 
@@ -166,6 +178,8 @@ export interface BuildConfig {
    *
    * - 在构建时，脚手架使用占位符的 key 建立正则模式 `/__${key}__/g`，并将匹配到的内容替换为 `value`。
    * - 替换发生在 `assets` 下的所有文件。
+   *
+   * @see {@link Context.templateData}
    */
   define: {
     [key: string]: string;
@@ -472,6 +486,15 @@ export interface ReleaseConfig {
      * @default "ci"
      */
     enable: "ci" | "local" | "always" | "false";
+    /**
+     * The information of remote repository.
+     *
+     * Will be extracted from the `repository` property in `package.json` by default.
+     *
+     * @default {{owner}}/{{repo}}
+     * @see {@link Context.templateData}
+     */
+    repository: string;
     /**
      * Upload update.json to release.
      *
@@ -497,15 +520,8 @@ export interface ReleaseConfig {
 
   /**
    * Release to Gitee
-   *
-   * @todo Not implemented yet
    */
-  gitee: {
-    enable: "ci" | "local" | "always" | "false";
-    updater: string | false;
-    comment: boolean;
-    releaseNote: (ctx: Context) => string;
-  };
+  gitee: ReleaseConfig["github"];
 
   hooks: Partial<ReleaseHooks>;
 };

src/types/index.ts

@@ -19,7 +19,20 @@ interface Context extends Config {
   version: string;
   hooks: Hookable<Hooks>;
   logger: InstanceType<typeof Log>;
-  templateData: { [placeholder: string]: string };
+  templateData: TemplateData;
+}
+
+export interface TemplateData {
+  /**
+   * `owner` and `repo` will be extracted from the `repository` property in `package.json`.
+   */
+  owner: string;
+  repo: string;
+  version: string;
+  isPreRelease: string;
+  updateJson: "update-beta.json" | "update.json" | string;
+  xpiName: string;
+  buildTime: string;
 }
 
 export { Config, Context, Hooks, OverrideConfig, UserConfig };