E2E draft tests (#144)

yairm210 · Yair Morgenstern · web-flow · commit 7edb9f02e818 · 2025-06-30T22:08:38.000+03:00
* test creating draft release

* Catch 404 error from get draft

* draft id as env variable

* .

* Test adding files to existing draft

* .

* .

* Change many debug logs to info

* Check both file names at once

* ...

* cleanup

* .

---------

Co-authored-by: Yair Morgenstern &lt;yair_morgenstern@il.yair.morgenstern.m2max16&gt;
diff --git a/.github/workflows/e2e_test.yml b/.github/workflows/e2e_test.yml
@@ -15,6 +15,72 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
+    - name: Make draft
+      id: make-draft
+      uses: ./
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: README.md
+        asset_name: TEST.md
+        tag: ci-test-${{ matrix.os }}-${{ github.run_id }}
+        draft: true
+        body: "rofl lol test%0Aianal %25 fubar"
+
+    - name: Assert draft release get be retrieved
+      uses: actions/github-script@v7
+      env:
+        DRAFT_ID: ${{ steps.make-draft.outputs.draft_id }}
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        script: |
+          const assert = require('assert').strict;
+
+          // We cannot find drafts by tag
+          try {
+            const release = await github.rest.repos.getReleaseByTag({
+              ...context.repo,
+              tag: "ci-test-${{ matrix.os }}-${{ github.run_id }}"
+            })
+          } catch (error) {
+            assert.equal(error.status, 404)
+          }
+          
+          // Instead we can find them by ID
+          const release = await github.request('GET /repos/{owner}/{repo}/releases/{release_id}', {
+            ...context.repo,
+            release_id: process.env.DRAFT_ID,
+          })
+          
+          assert.deepStrictEqual(release.data.draft, true)
+          assert.deepStrictEqual(release.data.body, "rofl lol test\nianal % fubar")
+          assert.deepStrictEqual(release.data.assets[0].name, "TEST.md")
+
+    - name: Add files to existing draft
+      uses: ./
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: README.md
+        asset_name: TEST2.md
+        draft: true
+        draft_id: ${{ steps.make-draft.outputs.draft_id }}
+        tag: ci-test-${{ matrix.os }}-${{ github.run_id }}
+
+    - name: Check that files can be uploaded to existing draft
+      uses: actions/github-script@v7
+      env:
+        DRAFT_ID: ${{ steps.make-draft.outputs.draft_id }}
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        script: |
+          const assert = require('assert').strict;
+          
+          const release = await github.request('GET /repos/{owner}/{repo}/releases/{release_id}', {
+            ...context.repo,
+            release_id: process.env.DRAFT_ID,
+          })
+          
+          assert.deepStrictEqual(release.data.assets.map(a => a.name), ["TEST.md", "TEST2.md"])
+
     - name: Make test pre-release
       uses: ./
       with:
diff --git a/dist/index.js b/dist/index.js
@@ -57,24 +57,34 @@ const glob = __importStar(__nccwpck_require__(1363));
 const attempt_1 = __nccwpck_require__(7552);
 const getRef = 'GET /repos/{owner}/{repo}/git/ref/{ref}';
 const releaseByTag = 'GET /repos/{owner}/{repo}/releases/tags/{tag}';
+const releaseByID = 'GET /repos/{owner}/{repo}/releases/{release_id}';
 const createRelease = 'POST /repos/{owner}/{repo}/releases';
 const updateRelease = 'PATCH /repos/{owner}/{repo}/releases/{release_id}';
 const repoAssets = 'GET /repos/{owner}/{repo}/releases/{release_id}/assets';
 const uploadAssets = 'POST {origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}';
 const deleteAssets = 'DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}';
-function get_release_by_tag(tag, draft, prerelease, make_latest, release_name, body, octokit, overwrite, promote, target_commit) {
-    return __awaiter(this, void 0, void 0, function* () {
+function get_release_by_tag(tag_1, draft_1, prerelease_1, make_latest_1, release_name_1, body_1, octokit_1, overwrite_1, promote_1, target_commit_1) {
+    return __awaiter(this, arguments, void 0, function* (tag, draft, prerelease, make_latest, release_name, body, octokit, overwrite, promote, target_commit, known_draft_id = 0) {
         let release;
         try {
-            core.debug(`Getting release by tag ${tag}.`);
-            // @ts-ignore
-            release = yield octokit.request(releaseByTag, Object.assign(Object.assign({}, repo()), { tag: tag }));
+            core.info(`Draft ID: ${known_draft_id}`);
+            if (draft && known_draft_id !== 0) {
+                // We are working with a draft release and we already created it
+                core.info(`Getting release by id ${known_draft_id} because we're working with a draft release.`);
+                release = yield octokit.request(releaseByID, Object.assign(Object.assign({}, repo()), { release_id: known_draft_id }));
+                core.debug(`The release has the following ID: ${release.data.id}`);
+            }
+            else {
+                core.info(`Getting release by tag ${tag}.`);
+                // @ts-ignore
+                release = yield octokit.request(releaseByTag, Object.assign(Object.assign({}, repo()), { tag: tag }));
+            }
         }
         catch (error) {
             // If this returns 404, we need to create the release first.
             if (error.status !== 404)
                 throw error;
-            core.debug(`Release for tag ${tag} doesn't exist yet so we'll create it now.`);
+            core.info(`Release for tag ${tag} doesn't exist yet so we'll create it now.`);
             if (target_commit) {
                 try {
                     yield octokit.request(getRef, Object.assign(Object.assign({}, repo()), { ref: `tags/${tag}` }));
@@ -86,7 +96,9 @@ function get_release_by_tag(tag, draft, prerelease, make_latest, release_name, b
                 }
             }
             // @ts-ignore
-            return yield octokit.request(createRelease, Object.assign(Object.assign({}, repo()), { tag_name: tag, draft: draft, prerelease: prerelease, make_latest: make_latest ? 'true' : 'false', name: release_name, body: body, target_commitish: target_commit }));
+            const _release = yield octokit.request(createRelease, Object.assign(Object.assign({}, repo()), { tag_name: tag, draft: draft, prerelease: prerelease, make_latest: make_latest ? 'true' : 'false', name: release_name, body: body, target_commitish: target_commit }));
+            core.setOutput('draft_id', _release.data.id);
+            return _release;
         }
         return yield update_release(promote, release, tag, overwrite, release_name, body, octokit);
     });
@@ -95,18 +107,18 @@ function update_release(promote, release, tag, overwrite, release_name, body, oc
     return __awaiter(this, void 0, void 0, function* () {
         let updateObject;
         if (promote && release.data.prerelease) {
-            core.debug(`The ${tag} is a prerelease, promoting it to a release.`);
+            core.info(`The ${tag} is a prerelease, promoting it to a release.`);
             updateObject = updateObject || {};
             updateObject.prerelease = false;
         }
         if (overwrite) {
             if (release_name && release.data.name !== release_name) {
-                core.debug(`The ${tag} release already exists with a different name ${release.data.name} so we'll overwrite it.`);
+                core.info(`The ${tag} release already exists with a different name ${release.data.name} so we'll overwrite it.`);
                 updateObject = updateObject || {};
                 updateObject.name = release_name;
             }
             if (body && release.data.body !== body) {
-                core.debug(`The ${tag} release already exists with a different body ${release.data.body} so we'll overwrite it.`);
+                core.info(`The ${tag} release already exists with a different body ${release.data.body} so we'll overwrite it.`);
                 updateObject = updateObject || {};
                 updateObject.body = body;
             }
@@ -122,12 +134,12 @@ function upload_to_release(release, file, asset_name, tag, overwrite, octokit, c
     return __awaiter(this, void 0, void 0, function* () {
         const stat = fs.statSync(file);
         if (!stat.isFile()) {
-            core.debug(`Skipping ${file}, since its not a file`);
+            core.warning(`Skipping ${file}, since its not a file`);
             return;
         }
         const file_size = stat.size;
         if (file_size === 0) {
-            core.debug(`Skipping ${file}, since its size is 0`);
+            core.warning(`Skipping ${file}, since its size is 0`);
             return;
         }
         if (check_duplicates) {
@@ -136,7 +148,7 @@ function upload_to_release(release, file, asset_name, tag, overwrite, octokit, c
             const duplicate_asset = assets.find(a => a.name === asset_name);
             if (duplicate_asset !== undefined) {
                 if (overwrite) {
-                    core.debug(`An asset called ${asset_name} already exists in release ${tag} so we'll overwrite it.`);
+                    core.info(`An asset called ${asset_name} already exists in release ${tag} so we'll overwrite it.`);
                     yield octokit.request(deleteAssets, Object.assign(Object.assign({}, repo()), { asset_id: duplicate_asset.id }));
                 }
                 else {
@@ -148,7 +160,7 @@ function upload_to_release(release, file, asset_name, tag, overwrite, octokit, c
                 core.debug(`No pre-existing asset called ${asset_name} found in release ${tag}. All good.`);
             }
         }
-        core.debug(`Uploading ${file} to ${asset_name} in release ${tag}.`);
+        core.info(`Uploading ${file} to ${asset_name} in release ${tag}.`);
         // @ts-ignore
         const uploaded_asset = yield (0, attempt_1.retry)(() => __awaiter(this, void 0, void 0, function* () {
             return octokit.request(uploadAssets, Object.assign(Object.assign({}, repo()), { release_id: release.data.id, url: release.data.upload_url, name: asset_name, data: fs.createReadStream(file), headers: {
@@ -198,14 +210,15 @@ function run() {
             const make_latest = core.getInput('make_latest') != 'false';
             const release_name = core.getInput('release_name');
             const target_commit = core.getInput('target_commit');
+            const draft_release_id = core.getInput('draft_id');
             const check_duplicates = core.getInput('check_duplicates') != 'false' ? true : false;
             const body = core
                 .getInput('body')
                 .replace(/%0A/gi, '\n')
                 .replace(/%0D/gi, '\r')
                 .replace(/%25/g, '%');
             const octokit = github.getOctokit(token);
-            const release = yield get_release_by_tag(tag, draft, prerelease, make_latest, release_name, body, octokit, overwrite, promote, target_commit);
+            const release = yield get_release_by_tag(tag, draft, prerelease, make_latest, release_name, body, octokit, overwrite, promote, target_commit, Number(draft_release_id));
             if (file_glob) {
                 const files = glob.sync(file);
                 if (files.length > 0) {
diff --git a/src/main.ts b/src/main.ts
@@ -40,11 +40,11 @@ async function get_release_by_tag(
 ): Promise<ReleaseByTagResp | CreateReleaseResp | UpdateReleaseResp> {
   let release: ReleaseByTagResp | ReleaseByIDResp
   try {
-    core.debug(`Draft ID: ${known_draft_id}`)
+    core.info(`Draft ID: ${known_draft_id}`)
 
-    if (draft === true && known_draft_id !== 0) {
+    if (draft && known_draft_id !== 0) {
       // We are working with a draft release and we already created it
-      core.debug(
+      core.info(
         `Getting release by id ${known_draft_id} because we're working with a draft release.`
       )
       release = await octokit.request(releaseByID, {
@@ -54,7 +54,7 @@ async function get_release_by_tag(
 
       core.debug(`The release has the following ID: ${release.data.id}`)
     } else {
-      core.debug(`Getting release by tag ${tag}.`)
+      core.info(`Getting release by tag ${tag}.`)
       // @ts-ignore
       release = await octokit.request(releaseByTag, {
         ...repo(),
@@ -65,7 +65,7 @@ async function get_release_by_tag(
     // If this returns 404, we need to create the release first.
     if (error.status !== 404) throw error
 
-    core.debug(
+    core.info(
       `Release for tag ${tag} doesn't exist yet so we'll create it now.`
     )
     if (target_commit) {
@@ -93,6 +93,7 @@ async function get_release_by_tag(
     core.setOutput('draft_id', _release.data.id)
     return _release
   }
+
   return await update_release(
     promote,
     release,
@@ -106,35 +107,38 @@ async function get_release_by_tag(
 
 async function update_release(
   promote: boolean,
-  release: ReleaseByTagResp,
+  release: ReleaseByTagResp | ReleaseByIDResp,
   tag: string,
   overwrite: boolean,
   release_name: string,
   body: string,
   octokit: Octokit
 ): Promise<ReleaseByTagResp | UpdateReleaseResp> {
   let updateObject: Partial<UpdateReleaseParams> | undefined
+
   if (promote && release.data.prerelease) {
-    core.debug(`The ${tag} is a prerelease, promoting it to a release.`)
+    core.info(`The ${tag} is a prerelease, promoting it to a release.`)
     updateObject = updateObject || {}
     updateObject.prerelease = false
   }
+
   if (overwrite) {
     if (release_name && release.data.name !== release_name) {
-      core.debug(
+      core.info(
         `The ${tag} release already exists with a different name ${release.data.name} so we'll overwrite it.`
       )
       updateObject = updateObject || {}
       updateObject.name = release_name
     }
     if (body && release.data.body !== body) {
-      core.debug(
+      core.info(
         `The ${tag} release already exists with a different body ${release.data.body} so we'll overwrite it.`
       )
       updateObject = updateObject || {}
       updateObject.body = body
     }
   }
+
   if (updateObject) {
     // @ts-ignore
     return await octokit.request(updateRelease, {
@@ -157,12 +161,12 @@ async function upload_to_release(
 ): Promise<undefined | string> {
   const stat = fs.statSync(file)
   if (!stat.isFile()) {
-    core.debug(`Skipping ${file}, since its not a file`)
+    core.warning(`Skipping ${file}, since its not a file`)
     return
   }
   const file_size = stat.size
   if (file_size === 0) {
-    core.debug(`Skipping ${file}, since its size is 0`)
+    core.warning(`Skipping ${file}, since its size is 0`)
     return
   }
 
@@ -175,7 +179,7 @@ async function upload_to_release(
     const duplicate_asset = assets.find(a => a.name === asset_name)
     if (duplicate_asset !== undefined) {
       if (overwrite) {
-        core.debug(
+        core.info(
           `An asset called ${asset_name} already exists in release ${tag} so we'll overwrite it.`
         )
         await octokit.request(deleteAssets, {
@@ -193,7 +197,7 @@ async function upload_to_release(
     }
   }
 
-  core.debug(`Uploading ${file} to ${asset_name} in release ${tag}.`)
+  core.info(`Uploading ${file} to ${asset_name} in release ${tag}.`)
 
   // @ts-ignore
   const uploaded_asset: UploadAssetResp = await retry(
