release prep for 0.1.14

CHANGELOG.md

@@ -1,6 +1,19 @@
+## 0.1.14
+
+- provides an new workflow input option `generate_release_notes` which when set to true will automatically generate release notes for you based on GitHub activity [#179](https://github.com/softprops/action-gh-release/pull/179). Please see the [GitHub docs for this feature](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) for more information
+
+## 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

README.md

@@ -165,20 +165,21 @@ 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                                                                                                                                                                                                                                                                                                                                         |
-| `prerelease`               | Boolean | Indicator of whether or not is a prerelease                                                                                                                                                                                                                                                                                                                                                 |
-| `files`                    | String  | Newline-delimited globs of paths to assets to upload for release                                                                                                                                                                                                                                                                                                                            |
-| `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) |
+| 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                                                                                                                                                                                                                                                                                                                                                                                             |
+| `prerelease`               | Boolean | Indicator of whether or not is a prerelease                                                                                                                                                                                                                                                                                                                                                                                                     |
+| `files`                    | String  | Newline-delimited globs of paths to assets to upload for release                                                                                                                                                                                                                                                                                                                                                                                |
+| `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)                                                     |
+| `generate_release_notes`   | Boolean | Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes. See the [GitHub docs for this feature](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) for more information |
 
 💡 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.
@@ -208,4 +209,15 @@ The following `step.env` keys are allowed as a fallback but deprecated in favor
 
 > **⚠️ Note:** This action was previously implemented as a Docker container, limiting its use to GitHub Actions Linux virtual environments only. With recent releases, we now support cross platform usage. You'll need to remove the `docker://` prefix in these versions
 
+### Permissions
+
+This Action requires the following permissions on the GitHub integration token:
+
+```yaml
+permissions:
+  contents: write
+```
+
+[GitHub token permissions](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) can be set for an individual job, workflow, or for Actions as a whole.
+
 Doug Tangren (softprops) 2019

__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}"
@@ -50,7 +50,8 @@ describe("util", () => {
           input_name: undefined,
           input_tag_name: undefined,
           input_target_commitish: undefined,
-          input_discussion_category_name: undefined
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false
         })
       );
     });
@@ -69,7 +70,8 @@ describe("util", () => {
           input_name: undefined,
           input_tag_name: undefined,
           input_target_commitish: undefined,
-          input_discussion_category_name: undefined
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false
         })
       );
     });
@@ -88,28 +90,42 @@ describe("util", () => {
           input_name: undefined,
           input_tag_name: undefined,
           input_target_commitish: undefined,
-          input_discussion_category_name: undefined
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false
         })
       );
     });
   });
   describe("parseConfig", () => {
     it("parses basic config", () => {
-      assert.deepStrictEqual(parseConfig({}), {
-        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: undefined
-      });
+      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: "",
+          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: undefined,
+          input_generate_release_notes: false
+        }
+      );
     });
 
     it("parses basic config with commitish", () => {
@@ -130,7 +146,8 @@ describe("util", () => {
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
           input_target_commitish: "affa18ef97bc9db20076945705aba8c516139abd",
-          input_discussion_category_name: undefined
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false
         }
       );
     });
@@ -152,10 +169,36 @@ describe("util", () => {
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
           input_target_commitish: undefined,
-          input_discussion_category_name: "releases"
+          input_discussion_category_name: "releases",
+          input_generate_release_notes: false
         }
       );
     });
+
+    it("supports generating release notes", () => {
+      assert.deepStrictEqual(
+        parseConfig({
+          INPUT_GENERATE_RELEASE_NOTES: "true"
+        }),
+        {
+          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: undefined,
+          input_generate_release_notes: true
+        }
+      );
+    });
+
     it("prefers GITHUB_TOKEN over token input for backwards compatibility", () => {
       assert.deepStrictEqual(
         parseConfig({
@@ -177,7 +220,8 @@ describe("util", () => {
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
           input_target_commitish: undefined,
-          input_discussion_category_name: undefined
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false
         }
       );
     });
@@ -201,7 +245,8 @@ describe("util", () => {
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
           input_target_commitish: undefined,
-          input_discussion_category_name: undefined
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false
         }
       );
     });
@@ -224,7 +269,8 @@ describe("util", () => {
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
           input_target_commitish: undefined,
-          input_discussion_category_name: undefined
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false
         }
       );
     });

action.yml

@@ -40,6 +40,9 @@ inputs:
   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
+  generate_release_notes:
+    description: "Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes."
+    required: false
 env:
   "GITHUB_TOKEN": "As provided by Github Actions"
 outputs:

package-lock.json

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

package.json

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

src/github.ts

@@ -44,6 +44,7 @@ export interface Releaser {
     prerelease: boolean | undefined;
     target_commitish: string | undefined;
     discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
   }): Promise<{ data: Release }>;
 
   updateRelease(params: {
@@ -57,6 +58,7 @@ export interface Releaser {
     draft: boolean | undefined;
     prerelease: boolean | undefined;
     discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
   }): Promise<{ data: Release }>;
 
   allReleases(params: {
@@ -89,6 +91,7 @@ export class GitHubReleaser implements Releaser {
     prerelease: boolean | undefined;
     target_commitish: string | undefined;
     discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
   }): Promise<{ data: Release }> {
     return this.github.rest.repos.createRelease(params);
   }
@@ -104,6 +107,7 @@ export class GitHubReleaser implements Releaser {
     draft: boolean | undefined;
     prerelease: boolean | undefined;
     discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
   }): Promise<{ data: Release }> {
     return this.github.rest.repos.updateRelease(params);
   }
@@ -167,7 +171,7 @@ 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 ${
+      `Failed to upload release asset ${name}. received status code ${
         resp.status
       }\n${json.message}\n${JSON.stringify(json.errors)}`
     );
@@ -193,6 +197,7 @@ export const release = async (
       : "");
 
   const discussion_category_name = config.input_discussion_category_name;
+  const generate_release_notes = config.input_generate_release_notes;
   try {
     // you can't get a an existing draft by tag
     // so we must find one in the list of all releases
@@ -229,12 +234,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
@@ -255,7 +259,8 @@ export const release = async (
       body,
       draft,
       prerelease,
-      discussion_category_name
+      discussion_category_name,
+      generate_release_notes
     });
     return release.data;
   } catch (error) {
@@ -283,7 +288,8 @@ export const release = async (
           draft,
           prerelease,
           target_commitish,
-          discussion_category_name
+          discussion_category_name,
+          generate_release_notes
         });
         return release.data;
       } catch (error) {

src/util.ts

@@ -17,6 +17,7 @@ export interface Config {
   input_fail_on_unmatched_files?: boolean;
   input_target_commitish?: string;
   input_discussion_category_name?: string;
+  input_generate_release_notes?: boolean;
 }
 
 export const uploadUrl = (url: string): string => {
@@ -63,8 +64,10 @@ 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_discussion_category_name: env.INPUT_DISCUSSION_CATEGORY_NAME
+    input_target_commitish: env.INPUT_TARGET_COMMITISH || undefined,
+    input_discussion_category_name:
+      env.INPUT_DISCUSSION_CATEGORY_NAME || undefined,
+    input_generate_release_notes: env.INPUT_GENERATE_RELEASE_NOTES == "true"
   };
 };