bump version and add changelog notes

* support linking to discussions

* fmt

* wire param

CHANGELOG.md

@@ -1,3 +1,23 @@
+## 0.1.13
+
+- fix issue with multiple runs concatenating release bodies [#145](https://github.com/softprops/action-gh-release/pull/145)
+
+## 0.1.12
+
+- fix bug leading to empty strings subsituted for inputs users don't provide breaking api calls [#144](https://github.com/softprops/action-gh-release/pull/144)
+
+## 0.1.11
+
+- better error message on release create failed [#143](https://github.com/softprops/action-gh-release/pull/143)
+
+## 0.1.10
+
+- fixed error message formatting for file uploads
+
+## 0.1.9
+
+- add support for linking release to GitHub discussion [#136](https://github.com/softprops/action-gh-release/pull/136)
+
 ## 0.1.8
 
 - address recent warnings in assert upload api as well as introduce asset upload overrides, allowing for multiple runs for the same release with the same named asserts [#134](https://github.com/softprops/action-gh-release/pull/134)

README.md

@@ -152,6 +152,9 @@ jobs:
         if: startsWith(github.ref, 'refs/tags/')
         with:
           body_path: ${{ github.workspace }}-CHANGELOG.txt
+          # note you'll typically need to create a personal access token
+          # with permissions to create releases in the other repo
+          token: ${{ secrets.CUSTOM_GITHUB_TOKEN }}
         env:
           GITHUB_REPOSITORY: my_gh_org/my_gh_repo
 ```
@@ -163,7 +166,7 @@ jobs:
 The following are optional as `step.with` keys
 
 | Name                       | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                 |
-| ------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
+| -------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `body`                     | String  | Text communicating notable changes in this release                                                                                                                                                                                                                                                                                                                                          |
 | `body_path`                | String  | Path to load text communicating notable changes in this release                                                                                                                                                                                                                                                                                                                             |
 | `draft`                    | Boolean | Indicator of whether or not this release is a draft                                                                                                                                                                                                                                                                                                                                         |
@@ -172,8 +175,10 @@ The following are optional as `step.with` keys
 | `name`                     | String  | Name of the release. defaults to tag name                                                                                                                                                                                                                                                                                                                                                   |
 | `tag_name`                 | String  | Name of a tag. defaults to `github.ref`                                                                                                                                                                                                                                                                                                                                                     |
 | `fail_on_unmatched_files`  | Boolean | Indicator of whether to fail if any of the `files` globs match nothing                                                                                                                                                                                                                                                                                                                      |
+| `repository`               | String  | Name of a target repository in `<owner>/<repo>` format. Defaults to GITHUB_REPOSITORY env variable                                                                                                                                                                                                                                                                                          |
 | `target_commitish`         | String  | Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA.                                                                                                                                                                                                                                                                                         |
 | `token`                    | String  | Secret GitHub Personal Access Token. Defaults to `${{ github.token }}`                                                                                                                                                                                                                                                                                                                      |
+| `discussion_category_name` | String  | If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see ["Managing categories for discussions in your repository."](https://docs.github.com/en/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository) |
 
 💡 When providing a `body` and `body_path` at the same time, `body_path` will be
 attempted first, then falling back on `body` if the path can not be read from.

__tests__/util.test.ts

@@ -11,7 +11,7 @@ import * as assert from "assert";
 
 describe("util", () => {
   describe("uploadUrl", () => {
-    it("stripts template", () => {
+    it("strips template", () => {
       assert.equal(
         uploadUrl(
           "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}"
@@ -49,7 +49,8 @@ describe("util", () => {
           input_files: [],
           input_name: undefined,
           input_tag_name: undefined,
-          input_target_commitish: undefined
+          input_target_commitish: undefined,
+          input_discussion_category_name: undefined
         })
       );
     });
@@ -67,7 +68,8 @@ describe("util", () => {
           input_files: [],
           input_name: undefined,
           input_tag_name: undefined,
-          input_target_commitish: undefined
+          input_target_commitish: undefined,
+          input_discussion_category_name: undefined
         })
       );
     });
@@ -85,14 +87,26 @@ describe("util", () => {
           input_files: [],
           input_name: undefined,
           input_tag_name: undefined,
-          input_target_commitish: undefined
+          input_target_commitish: undefined,
+          input_discussion_category_name: undefined
         })
       );
     });
   });
   describe("parseConfig", () => {
     it("parses basic config", () => {
-      assert.deepStrictEqual(parseConfig({}), {
+      assert.deepStrictEqual(
+        parseConfig({
+          // note: inputs declared in actions.yml, even when declared not required,
+          // are still provided by the actions runtime env as empty strings instead of
+          // the normal absent env value one would expect. this breaks things
+          // as an empty string !== undefined in terms of what we pass to the api
+          // so we cover that in a test case here to ensure undefined values are actually
+          // resolved as undefined and not empty strings
+          INPUT_TARGET_COMMITISH: "",
+          INPUT_DISCUSSION_CATEGORY_NAME: ""
+        }),
+        {
           github_ref: "",
           github_repository: "",
           github_token: "",
@@ -104,8 +118,10 @@ describe("util", () => {
           input_name: undefined,
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
-        input_target_commitish: undefined
-      });
+          input_target_commitish: undefined,
+          input_discussion_category_name: undefined
+        }
+      );
     });
 
     it("parses basic config with commitish", () => {
@@ -125,7 +141,30 @@ describe("util", () => {
           input_name: undefined,
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
-          input_target_commitish: "affa18ef97bc9db20076945705aba8c516139abd"
+          input_target_commitish: "affa18ef97bc9db20076945705aba8c516139abd",
+          input_discussion_category_name: undefined
+        }
+      );
+    });
+    it("supports discussion category names", () => {
+      assert.deepStrictEqual(
+        parseConfig({
+          INPUT_DISCUSSION_CATEGORY_NAME: "releases"
+        }),
+        {
+          github_ref: "",
+          github_repository: "",
+          github_token: "",
+          input_body: undefined,
+          input_body_path: undefined,
+          input_draft: undefined,
+          input_prerelease: undefined,
+          input_files: [],
+          input_name: undefined,
+          input_tag_name: undefined,
+          input_fail_on_unmatched_files: false,
+          input_target_commitish: undefined,
+          input_discussion_category_name: "releases"
         }
       );
     });
@@ -149,7 +188,8 @@ describe("util", () => {
           input_name: undefined,
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
-          input_target_commitish: undefined
+          input_target_commitish: undefined,
+          input_discussion_category_name: undefined
         }
       );
     });
@@ -172,7 +212,8 @@ describe("util", () => {
           input_name: undefined,
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
-          input_target_commitish: undefined
+          input_target_commitish: undefined,
+          input_discussion_category_name: undefined
         }
       );
     });
@@ -194,7 +235,8 @@ describe("util", () => {
           input_name: undefined,
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
-          input_target_commitish: undefined
+          input_target_commitish: undefined,
+          input_discussion_category_name: undefined
         }
       );
     });

action.yml

@@ -37,13 +37,16 @@ inputs:
   target_commitish:
     description: "Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA."
     required: false
+  discussion_category_name:
+    description: "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored."
+    required: false
 env:
   "GITHUB_TOKEN": "As provided by Github Actions"
 outputs:
   url:
-    description: 'URL to the Release HTML Page'
+    description: "URL to the Release HTML Page"
   id:
-    description: 'Release ID'
+    description: "Release ID"
   upload_url:
     description: "URL for uploading assets to the release"
 runs:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "action-gh-release",
-  "version": "0.1.8",
+  "version": "0.1.13",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "action-gh-release",
-  "version": "0.1.8",
+  "version": "0.1.13",
   "private": true,
   "description": "GitHub Action for creating GitHub Releases",
   "main": "lib/main.js",

src/github.ts

@@ -43,6 +43,7 @@ export interface Releaser {
     draft: boolean | undefined;
     prerelease: boolean | undefined;
     target_commitish: string | undefined;
+    discussion_category_name: string | undefined;
   }): Promise<{ data: Release }>;
 
   updateRelease(params: {
@@ -55,6 +56,7 @@ export interface Releaser {
     body: string | undefined;
     draft: boolean | undefined;
     prerelease: boolean | undefined;
+    discussion_category_name: string | undefined;
   }): Promise<{ data: Release }>;
 
   allReleases(params: {
@@ -86,6 +88,7 @@ export class GitHubReleaser implements Releaser {
     draft: boolean | undefined;
     prerelease: boolean | undefined;
     target_commitish: string | undefined;
+    discussion_category_name: string | undefined;
   }): Promise<{ data: Release }> {
     return this.github.rest.repos.createRelease(params);
   }
@@ -100,6 +103,7 @@ export class GitHubReleaser implements Releaser {
     body: string | undefined;
     draft: boolean | undefined;
     prerelease: boolean | undefined;
+    discussion_category_name: string | undefined;
   }): Promise<{ data: Release }> {
     return this.github.rest.repos.updateRelease(params);
   }
@@ -163,7 +167,9 @@ export const upload = async (
   const json = await resp.json();
   if (resp.status !== 201) {
     throw new Error(
-      "Failed to upload release asset ${name}. recieved status code ${resp.status}\n${json.message}\n${json.errors}"
+      `Failed to upload release asset ${name}. recieved status code ${
+        resp.status
+      }\n${json.message}\n${JSON.stringify(json.errors)}`
     );
   }
   return json;
@@ -185,6 +191,8 @@ export const release = async (
     (isTag(config.github_ref)
       ? config.github_ref.replace("refs/tags/", "")
       : "");
+
+  const discussion_category_name = config.input_discussion_category_name;
   try {
     // you can't get a an existing draft by tag
     // so we must find one in the list of all releases
@@ -221,12 +229,11 @@ export const release = async (
 
     const tag_name = tag;
     const name = config.input_name || existingRelease.data.name || tag;
-
-    let body: string = "";
-    if (existingRelease.data.body) body += existingRelease.data.body;
-    let workflowBody = releaseBody(config);
-    if (existingRelease.data.body && workflowBody) body += "\n";
-    if (workflowBody) body += workflowBody;
+    // revisit: support a new body-concat-strategy input for accumulating
+    // body parts as a release gets updated. some users will likely want this while
+    // others won't previously this was duplicating content for most which
+    // no one wants
+    let body = releaseBody(config) || existingRelease.data.body || "";
 
     const draft =
       config.input_draft !== undefined
@@ -246,7 +253,8 @@ export const release = async (
       name,
       body,
       draft,
-      prerelease
+      prerelease,
+      discussion_category_name
     });
     return release.data;
   } catch (error) {
@@ -273,7 +281,8 @@ export const release = async (
           body,
           draft,
           prerelease,
-          target_commitish
+          target_commitish,
+          discussion_category_name
         });
         return release.data;
       } catch (error) {
@@ -281,7 +290,9 @@ export const release = async (
         console.log(
           `⚠️ GitHub release failed with status: ${
             error.status
-          }, retrying... (${maxRetries - 1} retries remaining)`
+          }\n${JSON.stringify(
+            error.response.data.errors
+          )}\nretrying... (${maxRetries - 1} retries remaining)`
         );
         return release(config, releaser, maxRetries - 1);
       }

src/util.ts

@@ -16,6 +16,7 @@ export interface Config {
   input_prerelease?: boolean;
   input_fail_on_unmatched_files?: boolean;
   input_target_commitish?: string;
+  input_discussion_category_name?: string;
 }
 
 export const uploadUrl = (url: string): string => {
@@ -62,7 +63,9 @@ export const parseConfig = (env: Env): Config => {
       ? env.INPUT_PRERELEASE == "true"
       : undefined,
     input_fail_on_unmatched_files: env.INPUT_FAIL_ON_UNMATCHED_FILES == "true",
-    input_target_commitish: env.INPUT_TARGET_COMMITISH
+    input_target_commitish: env.INPUT_TARGET_COMMITISH || undefined,
+    input_discussion_category_name:
+      env.INPUT_DISCUSSION_CATEGORY_NAME || undefined
   };
 };