@minecraft/core-build-tasks 5.1.0 → 5.2.0

package/lib/tasks/publishRelease.d.ts

@@ -1,22 +1,45 @@
+import { TaskFunction } from 'just-scripts';
 /**
- * Configuration for publishing the release
+ * Gathers all files and compresses them into a zip archive as a release artifact.
+ */
+export type FilesArtifact = {
+    files: string[];
+    sourceFormat: 'files';
+};
+/**
+ * Specify a pre-existing archive file as a release artifact.
+ */
+export type ArchiveArtifact = {
+    path: string;
+    sourceFormat: 'archive';
+};
+/**
+ * Describes an artifact published with a release.
+ */
+export type PublishReleaseArtifact = FilesArtifact | ArchiveArtifact;
+/**
+ * Configuration for publishing the release.
  */
 export type PublishReleaseTaskConfig = {
     /**
-     * A custom message to include in the release
-     */
-    message: string;
-    /**
-     * Repo Owner/Organization
+     * Repo Owner/Organization.
      */
     repoOwner: string;
     /**
-     * Name of the repository
+     * Name of the repository.
      */
     repoName: string;
     /**
-     * GitHub token used for creating the release. If not specified, will attempt to use REPO_PAT environment variable
+     * A custom message to include in the release.
+     */
+    message: string;
+    /**
+     * Artifact to include in the release. If not specified, will upload the `dist` folder as a zip archive.
+     */
+    artifact?: PublishReleaseArtifact;
+    /**
+     * GitHub token used for creating the release. If not specified, will attempt to use `REPO_PAT` environment variable.
      */
     token?: string;
 };
-export declare function publishReleaseTask(config: PublishReleaseTaskConfig): () => Promise<void>;
+export declare function publishReleaseTask(config: PublishReleaseTaskConfig): TaskFunction;