Upload assets to GitHub release

.changeset/calm-oranges-sparkle.md

@@ -0,0 +1,5 @@
+---
+"@changesets/action": minor
+---
+
+Upload assets to GitHub release

README.md

@@ -12,6 +12,7 @@ This action for [Changesets](https://github.com/atlassian/changesets) creates a
 - title - The pull request title. Default to `Version Packages`
 - setupGitUser - Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
 - createGithubReleases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true`
+- githubReleaseAssets - A multiline list of glob paths to assets to be uploaded to the GitHub release notes
 - cwd - Changes node's `process.cwd()` if the project is not located on the root. Default to `process.cwd()`
 
 ### Outputs

action.yml

@@ -28,6 +28,9 @@ inputs:
     description: "A boolean value to indicate whether to create Github releases after `publish` or not"
     required: false
     default: true
+  githubReleaseAssets:
+    description: "A multiline list of glob paths to assets to be uploaded to the GitHub release notes"
+    required: false
 outputs:
   published:
     description: A boolean value to indicate whether a publishing is happened or not

package.json

@@ -36,6 +36,7 @@
     "@types/semver": "^6.0.2",
     "babel-jest": "^24.9.0",
     "fs-extra": "^8.1.0",
+    "glob": "^10.2.2",
     "husky": "^3.0.3",
     "jest": "^24.9.0",
     "mdast-util-to-string": "^1.0.6",

src/index.ts

@@ -85,6 +85,7 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
         script: publishScript,
         githubToken,
         createGithubReleases: core.getBooleanInput("createGithubReleases"),
+        githubReleaseAssets: core.getMultilineInput("githubReleaseAssets"),
       });
 
       if (result.published) {
@@ -103,6 +104,7 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
         prTitle: getOptionalInput("title"),
         commitMessage: getOptionalInput("commit"),
         hasPublishScript,
+        githubReleaseAssets: core.getMultilineInput("githubReleaseAssets"),
       });
 
       core.setOutput("pullRequestNumber", String(pullRequestNumber));

src/run.ts

@@ -15,6 +15,7 @@ import {
 import * as gitUtils from "./gitUtils";
 import readChangesetState from "./readChangesetState";
 import resolveFrom from "resolve-from";
+import { glob } from "glob";
 
 // GitHub Issues/PRs messages have a max size limit on the
 // message body payload.
@@ -24,7 +25,7 @@ const MAX_CHARACTERS_PER_MESSAGE = 60000;
 
 const createRelease = async (
   octokit: ReturnType<typeof github.getOctokit>,
-  { pkg, tagName }: { pkg: Package; tagName: string }
+  { pkg, tagName, assets }: { pkg: Package; tagName: string; assets: string[] }
 ) => {
   try {
     let changelogFileName = path.join(pkg.dir, "CHANGELOG.md");
@@ -40,13 +41,27 @@ const createRelease = async (
       );
     }
 
-    await octokit.repos.createRelease({
+    const release = await octokit.repos.createRelease({
       name: tagName,
       tag_name: tagName,
       body: changelogEntry.content,
       prerelease: pkg.packageJson.version.includes("-"),
       ...github.context.repo,
     });
+
+    for (const pattern of assets) {
+      const assets = await glob(pattern);
+      console.log(`Pattern ${pattern} matched the following assets: ${assets}`);
+      for (const asset of assets) {
+        await octokit.repos.uploadReleaseAsset({
+          release_id: release.data.id,
+          name: path.basename(asset),
+          // @ts-expect-error buffer is also accepted?
+          data: await fs.readFile(asset),
+          ...github.context.repo,
+        });
+      }
+    }
   } catch (err: any) {
     // if we can't find a changelog, the user has probably disabled changelogs
     if (err.code !== "ENOENT") {
@@ -59,6 +74,7 @@ type PublishOptions = {
   script: string;
   githubToken: string;
   createGithubReleases: boolean;
+  githubReleaseAssets: string[];
   cwd?: string;
 };
 
@@ -77,6 +93,7 @@ export async function runPublish({
   script,
   githubToken,
   createGithubReleases,
+  githubReleaseAssets,
   cwd = process.cwd(),
 }: PublishOptions): Promise<PublishResult> {
   let octokit = github.getOctokit(githubToken);
@@ -119,6 +136,7 @@ export async function runPublish({
           createRelease(octokit, {
             pkg,
             tagName: `${pkg.packageJson.name}@${pkg.packageJson.version}`,
+            assets: githubReleaseAssets,
           })
         )
       );
@@ -142,6 +160,7 @@ export async function runPublish({
           await createRelease(octokit, {
             pkg,
             tagName: `v${pkg.packageJson.version}`,
+            assets: githubReleaseAssets,
           });
         }
         break;
@@ -186,6 +205,7 @@ type GetMessageOptions = {
   }[];
   prBodyMaxCharacters: number;
   preState?: PreState;
+  githubReleaseAssets: string[];
 };
 
 export async function getVersionPrBody({
@@ -194,6 +214,7 @@ export async function getVersionPrBody({
   changedPackagesInfo,
   prBodyMaxCharacters,
   branch,
+  githubReleaseAssets,
 }: GetMessageOptions) {
   let messageHeader = `This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and ${
     hasPublishScript
@@ -241,6 +262,15 @@ export async function getVersionPrBody({
     ].join("\n");
   }
 
+  // Append the assets that are to be uploaded to the GitHub release
+  if (githubReleaseAssets.length) {
+    fullMessage += "\n";
+    fullMessage += "# GitHub Release Assets\n";
+    for (const asset of githubReleaseAssets) {
+      fullMessage += "1. `" + asset + "`\n";
+    }
+  }
+
   return fullMessage;
 }
 
@@ -252,6 +282,7 @@ type VersionOptions = {
   commitMessage?: string;
   hasPublishScript?: boolean;
   prBodyMaxCharacters?: number;
+  githubReleaseAssets: string[];
 };
 
 type RunVersionResult = {
@@ -266,6 +297,7 @@ export async function runVersion({
   commitMessage = "Version Packages",
   hasPublishScript = false,
   prBodyMaxCharacters = MAX_CHARACTERS_PER_MESSAGE,
+  githubReleaseAssets,
 }: VersionOptions): Promise<RunVersionResult> {
   let repo = `${github.context.repo.owner}/${github.context.repo.repo}`;
   let branch = github.context.ref.replace("refs/heads/", "");
@@ -338,6 +370,7 @@ export async function runVersion({
     branch,
     changedPackagesInfo,
     prBodyMaxCharacters,
+    githubReleaseAssets,
   });
 
   if (searchResult.data.items.length === 0) {