release 2.5.0

Signed-off-by: Rui Chen <rui@chenrui.dev>

.github/workflows/main.yml

@@ -8,9 +8,9 @@ jobs:
   build:
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
 
-      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v4
+      - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
         with:
           node-version-file: ".tool-versions"
           cache: "npm"

.tool-versions

@@ -1 +1 @@
-nodejs 24.2.0
+nodejs 24.11.0

CHANGELOG.md

@@ -1,3 +1,27 @@
+## 2.5.0
+
+## What's Changed
+
+### Exciting New Features 🎉
+
+* feat: mark release as draft until all artifacts are uploaded by @dumbmoron in https://github.com/softprops/action-gh-release/pull/692
+
+### Other Changes 🔄
+
+* dependency updates
+
+## 2.4.2
+
+## What's Changed
+
+### Exciting New Features 🎉
+
+* feat: Ensure generated release notes cannot be over 125000 characters by @BeryJu in https://github.com/softprops/action-gh-release/pull/684
+
+### Other Changes 🔄
+
+* dependency updates
+
 ## 2.4.1
 
 ## What's Changed

__tests__/github.test.ts

@@ -49,6 +49,7 @@ describe('github', () => {
       getReleaseByTag: () => Promise.reject('Not implemented'),
       createRelease: () => Promise.reject('Not implemented'),
       updateRelease: () => Promise.reject('Not implemented'),
+      finalizeRelease: () => Promise.reject('Not implemented'),
       allReleases: async function* () {
         yield { data: [mockRelease] };
       },
@@ -254,11 +255,12 @@ describe('github', () => {
               name: 'test',
               body: 'test',
               target_commitish: 'main',
-              draft: false,
+              draft: true,
               prerelease: false,
               assets: [],
             },
           }),
+        finalizeRelease: async () => {},
         allReleases: async function* () {
           yield {
             data: [

package.json

@@ -1,6 +1,6 @@
 {
   "name": "action-gh-release",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "private": true,
   "description": "GitHub Action for creating GitHub Releases",
   "main": "lib/main.js",
@@ -24,21 +24,21 @@
   "dependencies": {
     "@actions/core": "^1.11.1",
     "@actions/github": "^6.0.1",
-    "@octokit/plugin-retry": "^8.0.2",
-    "@octokit/plugin-throttling": "^11.0.2",
-    "glob": "^11.0.3",
-    "mime-types": "^3.0.1"
+    "@octokit/plugin-retry": "^8.0.3",
+    "@octokit/plugin-throttling": "^11.0.3",
+    "glob": "^13.0.0",
+    "mime-types": "^3.0.2"
   },
   "devDependencies": {
     "@types/glob": "^9.0.0",
     "@types/mime-types": "^3.0.1",
-    "@types/node": "^20.19.19",
+    "@types/node": "^20.19.25",
     "@vercel/ncc": "^0.38.4",
-    "@vitest/coverage-v8": "^3.2.4",
+    "@vitest/coverage-v8": "^4.0.13",
     "prettier": "3.6.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3",
     "typescript-formatter": "^7.2.2",
-    "vitest": "^3.1.4"
+    "vitest": "^4.0.4"
   }
 }

src/github.ts

@@ -58,6 +58,12 @@ export interface Releaser {
     make_latest: 'true' | 'false' | 'legacy' | undefined;
   }): Promise<{ data: Release }>;
 
+  finalizeRelease(params: {
+    owner: string;
+    repo: string;
+    release_id: number;
+  }): Promise<{ data: Release }>;
+
   allReleases(params: { owner: string; repo: string }): AsyncIterableIterator<{ data: Release[] }>;
 }
 
@@ -75,7 +81,27 @@ export class GitHubReleaser implements Releaser {
     return this.github.rest.repos.getReleaseByTag(params);
   }
 
-  createRelease(params: {
+  async getReleaseNotes(params: {
+    owner: string;
+    repo: string;
+    tag_name: string;
+    target_commitish: string | undefined;
+  }): Promise<{
+    data: {
+      name: string;
+      body: string;
+    };
+  }> {
+    return await this.github.rest.repos.generateReleaseNotes(params);
+  }
+
+  truncateReleaseNotes(input: string): string {
+    // release notes can be a maximum of 125000 characters
+    const githubNotesMaxCharLength = 125000;
+    return input.substring(0, githubNotesMaxCharLength - 1);
+  }
+
+  async createRelease(params: {
     owner: string;
     repo: string;
     tag_name: string;
@@ -94,11 +120,20 @@ export class GitHubReleaser implements Releaser {
     ) {
       params.make_latest = undefined;
     }
-
+    if (params.generate_release_notes) {
+      const releaseNotes = await this.getReleaseNotes(params);
+      params.generate_release_notes = false;
+      if (params.body) {
+        params.body = `${params.body}\n\n${releaseNotes.data.body}`;
+      } else {
+        params.body = releaseNotes.data.body;
+      }
+    }
+    params.body = params.body ? this.truncateReleaseNotes(params.body) : undefined;
     return this.github.rest.repos.createRelease(params);
   }
 
-  updateRelease(params: {
+  async updateRelease(params: {
     owner: string;
     repo: string;
     release_id: number;
@@ -118,10 +153,28 @@ export class GitHubReleaser implements Releaser {
     ) {
       params.make_latest = undefined;
     }
-
+    if (params.generate_release_notes) {
+      const releaseNotes = await this.getReleaseNotes(params);
+      params.generate_release_notes = false;
+      if (params.body) {
+        params.body = `${params.body}\n\n${releaseNotes.data.body}`;
+      } else {
+        params.body = releaseNotes.data.body;
+      }
+    }
+    params.body = params.body ? this.truncateReleaseNotes(params.body) : undefined;
     return this.github.rest.repos.updateRelease(params);
   }
 
+  async finalizeRelease(params: { owner: string; repo: string; release_id: number }) {
+    return await this.github.rest.repos.updateRelease({
+      owner: params.owner,
+      repo: params.repo,
+      release_id: params.release_id,
+      draft: false,
+    });
+  }
+
   allReleases(params: { owner: string; repo: string }): AsyncIterableIterator<{ data: Release[] }> {
     const updatedParams = { per_page: 100, ...params };
     return this.github.paginate.iterator(
@@ -265,7 +318,6 @@ export const release = async (
       body = workflowBody || existingReleaseBody;
     }
 
-    const draft = config.input_draft !== undefined ? config.input_draft : existingRelease.draft;
     const prerelease =
       config.input_prerelease !== undefined ? config.input_prerelease : existingRelease.prerelease;
 
@@ -279,7 +331,7 @@ export const release = async (
       target_commitish,
       name,
       body,
-      draft,
+      draft: existingRelease.draft,
       prerelease,
       discussion_category_name,
       generate_release_notes,
@@ -307,6 +359,45 @@ export const release = async (
   }
 };
 
+/**
+ * Finalizes a release by unmarking it as "draft" (if relevant)
+ * after all artifacts have been uploaded.
+ *
+ * @param config - Release configuration as specified by user
+ * @param releaser - The GitHub API wrapper for release operations
+ * @param release - The existing release to be finalized
+ * @param maxRetries - The maximum number of attempts to finalize the release
+ */
+export const finalizeRelease = async (
+  config: Config,
+  releaser: Releaser,
+  release: Release,
+  maxRetries: number = 3,
+): Promise<Release> => {
+  if (config.input_draft === true) {
+    return release;
+  }
+
+  if (maxRetries <= 0) {
+    console.log(`❌ Too many retries. Aborting...`);
+    throw new Error('Too many retries.');
+  }
+
+  const [owner, repo] = config.github_repository.split('/');
+  try {
+    const { data } = await releaser.finalizeRelease({
+      owner,
+      repo,
+      release_id: release.id,
+    });
+
+    return data;
+  } catch {
+    console.log(`retrying... (${maxRetries - 1} retries remaining)`);
+    return finalizeRelease(config, releaser, release, maxRetries - 1);
+  }
+};
+
 /**
  * Finds a release by tag name from all a repository's releases.
  *
@@ -347,7 +438,6 @@ async function createRelease(
   const tag_name = tag;
   const name = config.input_name || tag;
   const body = releaseBody(config);
-  const draft = config.input_draft;
   const prerelease = config.input_prerelease;
   const target_commitish = config.input_target_commitish;
   const make_latest = config.input_make_latest;
@@ -363,7 +453,7 @@ async function createRelease(
       tag_name,
       name,
       body,
-      draft,
+      draft: true,
       prerelease,
       target_commitish,
       discussion_category_name,

src/main.ts

@@ -1,6 +1,6 @@
 import { setFailed, setOutput } from '@actions/core';
 import { getOctokit } from '@actions/github';
-import { GitHubReleaser, release, upload } from './github';
+import { GitHubReleaser, release, finalizeRelease, upload } from './github';
 import { isTag, parseConfig, paths, unmatchedPatterns, uploadUrl } from './util';
 
 import { env } from 'process';
@@ -48,7 +48,8 @@ async function run() {
       },
     });
     //);
-    const rel = await release(config, new GitHubReleaser(gh));
+    const releaser = new GitHubReleaser(gh);
+    let rel = await release(config, releaser);
     if (config.input_files && config.input_files.length > 0) {
       const files = paths(config.input_files, config.input_working_directory);
       if (files.length == 0) {
@@ -81,6 +82,10 @@ async function run() {
       const assets = results.filter(Boolean);
       setOutput('assets', assets);
     }
+
+    console.log('Finalizing release...');
+    rel = await finalizeRelease(config, releaser, rel);
+
     console.log(`🎉 Release ready at ${rel.html_url}`);
     setOutput('url', rel.html_url);
     setOutput('id', rel.id.toString());