prep release

* make pattern error opt in

* changelog link

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: weekly
+  ignore:
+  - dependency-name: node-fetch
+    versions:
+    - ">=3.0.0"
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly

.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
     steps:
       # https://github.com/actions/checkout
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install
         run: npm ci
       - name: Build

.nvmrc

@@ -0,0 +1 @@
+20.11.1

CHANGELOG.md

@@ -1,3 +1,67 @@
+## 2.0.4 (unreleased)
+
+## 2.0.3
+
+- Declare `make_latest` as an input field in `action.yml` [#419](https://github.com/softprops/action-gh-release/pull/419)
+
+## 2.0.2
+
+- Revisit approach to [#384](https://github.com/softprops/action-gh-release/pull/384) making unresolved pattern failures opt-in [#417](https://github.com/softprops/action-gh-release/pull/417)
+
+## 2.0.1
+
+- Add support for make_latest property [#304](https://github.com/softprops/action-gh-release/pull/304) via [@samueljseay](https://github.com/samueljseay)
+- Fail run if files setting contains invalid patterns [#384](https://github.com/softprops/action-gh-release/pull/384) via [@rpdelaney](https://github.com/rpdelaney)
+- Add support for proxy env variables (don't use node-fetch) [#386](https://github.com/softprops/action-gh-release/pull/386/) via [@timor-raiman](https://github.com/timor-raiman)
+- Suppress confusing warning when input_files is empty [#389](https://github.com/softprops/action-gh-release/pull/389) via [@Drowze](https://github.com/Drowze)
+
+## 2.0.0
+
+- `2.0.0`!? this release corrects a disjunction between git tag versions used in the marketplace and versions list this file. Previous versions should have really been 1.\*. Going forward this should be better aligned.
+- Upgrade action.yml declaration to node20 to address deprecations
+
+## 0.1.15
+
+- Upgrade to action.yml declaration to node16 to address deprecations
+- Upgrade dependencies
+- Add `asset` output as a JSON array containing information about the uploaded assets
+
+## 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
+
+## 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)
+- fix backwards compatibility with `GITHUB_TOKEN` resolution. `GITHUB_TOKEN` is no resolved first from an env varibale and then from and input [#133](https://github.com/softprops/action-gh-release/pull/133)
+- trim white space in provided `tag_name` [#130](https://github.com/softprops/action-gh-release/pull/130)
+
+## 0.1.7
+
+- allow creating draft releases without a tag [#95](https://github.com/softprops/action-gh-release/pull/95)
+- Set default token for simpler setup [#83](https://github.com/softprops/action-gh-release/pull/83)
+- fix regression with action yml [#126](https://github.com/softprops/action-gh-release/pull/126)
+
 ## 0.1.6
 
 This is a release catch up have a hiatus. Future releases will happen more frequently

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2019 Doug Tangren
+Copyright (c) 2019-current Doug Tangren
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -1,4 +1,3 @@
-
 <div align="center">
   📦 :octocat:
 </div>
@@ -20,7 +19,6 @@
 	</a>
 </div>
 
-
 <br />
 
 ## 🤸 Usage
@@ -43,12 +41,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         if: startsWith(github.ref, 'refs/tags/')
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 You can also use push config tag filter
@@ -59,18 +55,16 @@ name: Main
 on:
   push:
     tags:
-      - 'v*.*.*'
+      - "v*.*.*"
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 ### ⬆️ Uploading release assets
@@ -94,18 +88,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Build
         run: echo ${{ github.sha }} > Release.txt
       - name: Test
         run: cat Release.txt
       - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: Release.txt
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 Below is an example of uploading more than one asset with a GitHub release
@@ -120,23 +112,23 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Build
         run: echo ${{ github.sha }} > Release.txt
       - name: Test
         run: cat Release.txt
       - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: |
             Release.txt
             LICENSE
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-> **⚠️ Note:** Notice the `|` in the yaml syntax above ☝️. That let's you effectively declare a multi-line yaml string. You can learn more about multi-line yaml syntax [here](https://yaml-multiline.info)
+> **⚠️ Note:** Notice the `|` in the yaml syntax above ☝️. That lets you effectively declare a multi-line yaml string. You can learn more about multi-line yaml syntax [here](https://yaml-multiline.info)
+
+> **⚠️ Note for Windows:** Paths must use `/` as a separator, not `\`, as `\` is used to escape characters with special meaning in the pattern; for example, instead of specifying `D:\Foo.txt`, you must specify `D:/Foo.txt`. If you're using PowerShell, you can do this with `$Path = $Path -replace '\\','/'`
 
 ### 📝 External release notes
 
@@ -154,16 +146,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Generate Changelog
-        run: echo "# Good things have arrived" > ${{ github.workflow }}-CHANGELOG.txt
+        run: echo "# Good things have arrived" > ${{ github.workspace }}-CHANGELOG.txt
       - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         if: startsWith(github.ref, 'refs/tags/')
         with:
-          body_path: ${{ github.workflow }}-CHANGELOG.txt
+          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_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GITHUB_REPOSITORY: my_gh_org/my_gh_repo
 ```
 
@@ -174,7 +168,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                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -183,7 +177,13 @@ 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                                                                                                                                                                                                                                                                                                                                                                          |
-| `target_commitish`        | String  | Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. |
+| `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. Defaults to repository default branch.                                                                                                                                                                                                                                                                                                      |
+| `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 |
+| `append_body`              | Boolean | Append to existing body instead of overwriting it                                                                                                                                                                                                                                                                                                                                                                                               |
+| `make_latest`              | String  | Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Can be `true`, `false`, or `legacy`. Uses GitHub api defaults if not provided                                                                                                                                                                                                                            |
 
 💡 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.
@@ -197,22 +197,45 @@ release will retain its original info.
 The following outputs can be accessed via `${{ steps.<step-id>.outputs }}` from this action
 
 | Name         | Type   | Description                                                                                                                                                                               |
-|-------------|---------|-----------------------------------------------------------------|
+| ------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `url`        | String | Github.com URL for the release                                                                                                                                                            |
 | `id`         | String | Release ID                                                                                                                                                                                |
 | `upload_url` | String | URL for uploading assets to the release                                                                                                                                                   |
+| `assets`     | String | JSON array containing information about each uploaded asset, in the format given [here](https://docs.github.com/en/rest/releases/assets#get-a-release-asset) (minus the `uploader` field) |
 
+As an example, you can use `${{ fromJSON(steps.<step-id>.outputs.assets)[0].browser_download_url }}` to get the download URL of the first asset.
 
 #### environment variables
 
-The following are *required* as `step.env` keys
+The following `step.env` keys are allowed as a fallback but deprecated in favor of using inputs.
 
 | Name                | Description                                                                                |
-|----------------|--------------------------------------|
+| ------------------- | ------------------------------------------------------------------------------------------ |
 | `GITHUB_TOKEN`      | GITHUB_TOKEN as provided by `secrets`                                                      |
 | `GITHUB_REPOSITORY` | Name of a target repository in `<owner>/<repo>` format. defaults to the current repository |
 
-
 > **⚠️ 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
+```
+
+When used with `discussion_category_name`, additional permission is needed:
+
+```yaml
+permissions:
+  contents: write
+  discussions: 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.
+
+Note that if you intend to run workflows on the release event (`on: { release: { types: [published] } }`), you need to use
+a personal access token for this action, as the [default `secrets.GITHUB_TOKEN` does not trigger another workflow](https://github.com/actions/create-release/issues/71).
+
 Doug Tangren (softprops) 2019

__tests__/github.test.ts

@@ -15,11 +15,11 @@ describe("github", () => {
 
   describe("asset", () => {
     it("derives asset info from a path", async () => {
-      const { name, mime, size, file } = asset("tests/data/foo/bar.txt");
+      const { name, mime, size, data } = asset("tests/data/foo/bar.txt");
       assert.equal(name, "bar.txt");
       assert.equal(mime, "text/plain");
       assert.equal(size, 10);
-      assert.equal(file.toString(), "release me");
+      assert.equal(data.toString(), "release me");
     });
   });
 });

__tests__/util.test.ts

@@ -4,11 +4,22 @@ import {
   paths,
   parseConfig,
   parseInputFiles,
-  unmatchedPatterns
+  unmatchedPatterns,
+  uploadUrl,
 } from "../src/util";
 import * as assert from "assert";
 
 describe("util", () => {
+  describe("uploadUrl", () => {
+    it("strips template", () => {
+      assert.equal(
+        uploadUrl(
+          "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}"
+        ),
+        "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets"
+      );
+    });
+  });
   describe("parseInputFiles", () => {
     it("parses empty strings", () => {
       assert.deepStrictEqual(parseInputFiles(""), []);
@@ -38,7 +49,10 @@ describe("util", () => {
           input_files: [],
           input_name: undefined,
           input_tag_name: undefined,
-          input_target_commitish: undefined
+          input_target_commitish: undefined,
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false,
+          input_make_latest: undefined,
         })
       );
     });
@@ -56,7 +70,10 @@ describe("util", () => {
           input_files: [],
           input_name: undefined,
           input_tag_name: undefined,
-          input_target_commitish: undefined
+          input_target_commitish: undefined,
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false,
+          input_make_latest: undefined,
         })
       );
     });
@@ -74,39 +91,32 @@ describe("util", () => {
           input_files: [],
           input_name: undefined,
           input_tag_name: undefined,
-          input_target_commitish: undefined
+          input_target_commitish: undefined,
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false,
+          input_make_latest: undefined,
         })
       );
     });
   });
   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
-      });
-    });
-  });
-  describe("parseConfig", () => {
-    it("parses basic config with commitish", () => {
       assert.deepStrictEqual(
         parseConfig({
-          INPUT_TARGET_COMMITISH: "affa18ef97bc9db20076945705aba8c516139abd"
+          // 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_append_body: false,
           input_body: undefined,
           input_body_path: undefined,
           input_draft: undefined,
@@ -115,20 +125,104 @@ describe("util", () => {
           input_name: undefined,
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
-          input_target_commitish: "affa18ef97bc9db20076945705aba8c516139abd"
+          input_target_commitish: undefined,
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false,
+          input_make_latest: undefined,
         }
       );
     });
-    it("parses basic config with draft and prerelease", () => {
+
+    it("parses basic config with commitish", () => {
       assert.deepStrictEqual(
         parseConfig({
-          INPUT_DRAFT: "false",
+          INPUT_TARGET_COMMITISH: "affa18ef97bc9db20076945705aba8c516139abd",
-          INPUT_PRERELEASE: "true"
         }),
         {
           github_ref: "",
           github_repository: "",
           github_token: "",
+          input_append_body: false,
+          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: "affa18ef97bc9db20076945705aba8c516139abd",
+          input_discussion_category_name: undefined,
+          input_generate_release_notes: false,
+          input_make_latest: undefined,
+        }
+      );
+    });
+    it("supports discussion category names", () => {
+      assert.deepStrictEqual(
+        parseConfig({
+          INPUT_DISCUSSION_CATEGORY_NAME: "releases",
+        }),
+        {
+          github_ref: "",
+          github_repository: "",
+          github_token: "",
+          input_append_body: false,
+          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",
+          input_generate_release_notes: false,
+          input_make_latest: undefined,
+        }
+      );
+    });
+
+    it("supports generating release notes", () => {
+      assert.deepStrictEqual(
+        parseConfig({
+          INPUT_GENERATE_RELEASE_NOTES: "true",
+        }),
+        {
+          github_ref: "",
+          github_repository: "",
+          github_token: "",
+          input_append_body: false,
+          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,
+          input_make_latest: undefined,
+        }
+      );
+    });
+
+    it("prefers GITHUB_TOKEN over token input for backwards compatibility", () => {
+      assert.deepStrictEqual(
+        parseConfig({
+          INPUT_DRAFT: "false",
+          INPUT_PRERELEASE: "true",
+          GITHUB_TOKEN: "env-token",
+          INPUT_TOKEN: "input-token",
+        }),
+        {
+          github_ref: "",
+          github_repository: "",
+          github_token: "env-token",
+          input_append_body: false,
           input_body: undefined,
           input_body_path: undefined,
           input_draft: false,
@@ -137,7 +231,113 @@ 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,
+          input_generate_release_notes: false,
+          input_make_latest: undefined,
+        }
+      );
+    });
+    it("uses input token as the source of GITHUB_TOKEN by default", () => {
+      assert.deepStrictEqual(
+        parseConfig({
+          INPUT_DRAFT: "false",
+          INPUT_PRERELEASE: "true",
+          INPUT_TOKEN: "input-token",
+        }),
+        {
+          github_ref: "",
+          github_repository: "",
+          github_token: "input-token",
+          input_append_body: false,
+          input_body: undefined,
+          input_body_path: undefined,
+          input_draft: false,
+          input_prerelease: true,
+          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,
+          input_make_latest: undefined,
+        }
+      );
+    });
+    it("parses basic config with draft and prerelease", () => {
+      assert.deepStrictEqual(
+        parseConfig({
+          INPUT_DRAFT: "false",
+          INPUT_PRERELEASE: "true",
+        }),
+        {
+          github_ref: "",
+          github_repository: "",
+          github_token: "",
+          input_append_body: false,
+          input_body: undefined,
+          input_body_path: undefined,
+          input_draft: false,
+          input_prerelease: true,
+          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,
+          input_make_latest: undefined,
+        }
+      );
+    });
+    it("parses basic config where make_latest is passed", () => {
+      assert.deepStrictEqual(
+        parseConfig({
+          INPUT_MAKE_LATEST: "false",
+        }),
+        {
+          github_ref: "",
+          github_repository: "",
+          github_token: "",
+          input_append_body: false,
+          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,
+          input_make_latest: "false",
+        }
+      );
+    });
+    it("parses basic config with append_body", () => {
+      assert.deepStrictEqual(
+        parseConfig({
+          INPUT_APPEND_BODY: "true",
+        }),
+        {
+          github_ref: "",
+          github_repository: "",
+          github_token: "",
+          input_append_body: true,
+          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,
+          input_make_latest: undefined,
         }
       );
     });

action.yml

@@ -1,50 +1,68 @@
 # https://help.github.com/en/articles/metadata-syntax-for-github-actions
-name: 'GH Release'
+name: "GH Release"
-description: 'Github Action for creating Github Releases'
+description: "Github Action for creating Github Releases"
-author: 'softprops'
+author: "softprops"
 inputs:
   body:
-    description: 'Note-worthy description of changes in release'
+    description: "Note-worthy description of changes in release"
     required: false
   body_path:
-    description: 'Path to load note-worthy description of changes in release from'
+    description: "Path to load note-worthy description of changes in release from"
     required: false
   name:
-    description: 'Gives the release a custom name. Defaults to tag name'
+    description: "Gives the release a custom name. Defaults to tag name"
     required: false
   tag_name:
-    description: 'Gives a tag name. Defaults to github.GITHUB_REF'
+    description: "Gives a tag name. Defaults to github.GITHUB_REF"
     required: false
   draft:
-    description: 'Creates a draft release. Defaults to false'
+    description: "Creates a draft release. Defaults to false"
     required: false
   prerelease:
-    description: 'Identify the release as a prerelease. Defaults to false'
+    description: "Identify the release as a prerelease. Defaults to false"
     required: false
   files:
-    description: 'Newline-delimited list of path globs for asset files to upload'
+    description: "Newline-delimited list of path globs for asset files to upload"
     required: false
   fail_on_unmatched_files:
-    description: 'Fails if any of the `files` globs match nothing. Defaults to false'
+    description: "Fails if any of the `files` globs match nothing. Defaults to false"
     required: false
   repository:
-    description: 'Repository to make releases against, in <owner>/<repo> format'
+    description: "Repository to make releases against, in <owner>/<repo> format"
     required: false
+  token:
+    description: "Authorized secret GitHub Personal Access Token. Defaults to github.token"
+    required: false
+    default: ${{ github.token }}
   target_commitish:
-    description: 'Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA.'
+    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
+  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
+  append_body:
+    description: "Append to existing body instead of overwriting it. Default is false."
+    required: false
+  make_latest:
+    description: "Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Can be `true`, `false`, or `legacy`. Uses GitHub api default if not provided"
     required: false
 env:
-  'GITHUB_TOKEN': 'As provided by Github Actions'
+  "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'
+    description: "URL for uploading assets to the release"
+  assets:
+    description: "JSON array containing information about each uploaded asset, in the format given [here](https://docs.github.com/en/rest/reference/repos#upload-a-release-asset--code-samples) (minus the `uploader` field)"
 runs:
-  using: 'node12'
+  using: "node20"
-  main: 'dist/index.js'
+  main: "dist/index.js"
 branding:
-  color: 'green'
+  color: "green"
-  icon: 'package'
+  icon: "package"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "action-gh-release",
-  "version": "0.1.6",
+  "version": "2.0.3",
   "private": true,
   "description": "GitHub Action for creating GitHub Releases",
   "main": "lib/main.js",
@@ -12,32 +12,31 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/softprops/action-gh-template.git"
+    "url": "git+https://github.com/softprops/action-gh-release.git"
   },
   "keywords": [
     "actions"
   ],
   "author": "softprops",
-  "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.2.6",
+    "@actions/core": "^1.10.0",
-    "@actions/github": "^2.0.0",
+    "@actions/github": "^5.1.1",
-    "@octokit/plugin-retry": "^3.0.2",
+    "@octokit/plugin-retry": "^4.0.3",
-    "@octokit/plugin-throttling": "^3.2.1",
+    "@octokit/plugin-throttling": "^4.3.2",
-    "glob": "^7.1.6",
+    "glob": "^8.0.3",
-    "mime": "^2.4.4"
+    "mime": "^3.0.0"
   },
   "devDependencies": {
-    "@types/glob": "^7.1.1",
+    "@types/glob": "^8.0.0",
-    "@types/jest": "^24.0.25",
+    "@types/jest": "^29.2.3",
-    "@types/mime": "^2.0.1",
+    "@types/mime": "^3.0.1",
-    "@types/node": "^12.12.24",
+    "@types/node": "^18.11.9",
-    "@zeit/ncc": "^0.21.0",
+    "@vercel/ncc": "^0.34.0",
-    "jest": "^24.9.0",
+    "jest": "^29.3.1",
-    "jest-circus": "^24.9.0",
+    "jest-circus": "^29.3.1",
-    "prettier": "1.19.1",
+    "prettier": "2.8.0",
-    "ts-jest": "^24.2.0",
+    "ts-jest": "^29.0.3",
-    "typescript": "^3.7.4",
+    "typescript": "^4.9.3",
     "typescript-formatter": "^7.2.2"
   }
 }

release.sh

@@ -1,17 +0,0 @@
-#!/bin/bash
-# actions requires a node_modules dir https://github.com/actions/toolkit/blob/master/docs/javascript-action.md#publish-a-releasesv1-action
-# but its recommended not to check these in https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#recommendations
-# as such the following hack is how we dill with it
-
-if [[ $# -ne 1 ]]; then
-	echo "please pass a release version. i.e. $0 v1"
-	exit 1
-fi
-
-git checkout -b releases/$1 # If this branch already exists, omit the -b flag
-rm -rf node_modules
-sed -i '/node_modules/d' .gitignore # Bash command that removes node_modules from .gitignore
-npm install --production
-git add node_modules -f .gitignore
-git commit -m node_modules
-git push origin releases/$1

src/github.ts

@@ -1,14 +1,16 @@
-import { GitHub } from "@actions/github";
+import { GitHub } from "@actions/github/lib/utils";
-import { Config, releaseBody } from "./util";
+import { Config, isTag, releaseBody } from "./util";
-import { lstatSync, readFileSync } from "fs";
+import { statSync, readFileSync } from "fs";
 import { getType } from "mime";
 import { basename } from "path";
 
+type GitHub = InstanceType<typeof GitHub>;
+
 export interface ReleaseAsset {
   name: string;
   mime: string;
   size: number;
-  file: Buffer;
+  data: Buffer;
 }
 
 export interface Release {
@@ -16,11 +18,12 @@ export interface Release {
   upload_url: string;
   html_url: string;
   tag_name: string;
-  name: string;
+  name: string | null;
-  body: string;
+  body?: string | null | undefined;
   target_commitish: string;
   draft: boolean;
   prerelease: boolean;
+  assets: Array<{ id: number; name: string }>;
 }
 
 export interface Releaser {
@@ -39,6 +42,9 @@ export interface Releaser {
     draft: boolean | undefined;
     prerelease: boolean | undefined;
     target_commitish: string | undefined;
+    discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
+    make_latest: string | undefined;
   }): Promise<{ data: Release }>;
 
   updateRelease(params: {
@@ -51,6 +57,9 @@ export interface Releaser {
     body: string | undefined;
     draft: boolean | undefined;
     prerelease: boolean | undefined;
+    discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
+    make_latest: string | undefined;
   }): Promise<{ data: Release }>;
 
   allReleases(params: {
@@ -70,7 +79,7 @@ export class GitHubReleaser implements Releaser {
     repo: string;
     tag: string;
   }): Promise<{ data: Release }> {
-    return this.github.repos.getReleaseByTag(params);
+    return this.github.rest.repos.getReleaseByTag(params);
   }
 
   createRelease(params: {
@@ -82,8 +91,11 @@ export class GitHubReleaser implements Releaser {
     draft: boolean | undefined;
     prerelease: boolean | undefined;
     target_commitish: string | undefined;
+    discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
+    make_latest: string | undefined;
   }): Promise<{ data: Release }> {
-    return this.github.repos.createRelease(params);
+    return this.github.rest.repos.createRelease(params);
   }
 
   updateRelease(params: {
@@ -96,8 +108,11 @@ export class GitHubReleaser implements Releaser {
     body: string | undefined;
     draft: boolean | undefined;
     prerelease: boolean | undefined;
+    discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
+    make_latest: string | undefined;
   }): Promise<{ data: Release }> {
-    return this.github.repos.updateRelease(params);
+    return this.github.rest.repos.updateRelease(params);
   }
 
   allReleases(params: {
@@ -106,7 +121,7 @@ export class GitHubReleaser implements Releaser {
   }): AsyncIterableIterator<{ data: Release[] }> {
     const updatedParams = { per_page: 100, ...params };
     return this.github.paginate.iterator(
-      this.github.repos.listReleases.endpoint.merge(updatedParams)
+      this.github.rest.repos.listReleases.endpoint.merge(updatedParams)
     );
   }
 }
@@ -115,8 +130,8 @@ export const asset = (path: string): ReleaseAsset => {
   return {
     name: basename(path),
     mime: mimeOrDefault(path),
-    size: lstatSync(path).size,
+    size: statSync(path).size,
-    file: readFileSync(path)
+    data: readFileSync(path),
   };
 };
 
@@ -125,21 +140,47 @@ export const mimeOrDefault = (path: string): string => {
 };
 
 export const upload = async (
-  gh: GitHub,
+  config: Config,
+  github: GitHub,
   url: string,
-  path: string
+  path: string,
+  currentAssets: Array<{ id: number; name: string }>
 ): Promise<any> => {
-  let { name, size, mime, file } = asset(path);
+  const [owner, repo] = config.github_repository.split("/");
-  console.log(`⬆️ Uploading ${name}...`);
+  const { name, size, mime, data: body } = asset(path);
-  return await gh.repos.uploadReleaseAsset({
+  const currentAsset = currentAssets.find(
-    url,
+    ({ name: currentName }) => currentName == name
-    headers: {
+  );
-      "content-length": size,
+  if (currentAsset) {
-      "content-type": mime
+    console.log(`♻️ Deleting previously uploaded asset ${name}...`);
-    },
+    await github.rest.repos.deleteReleaseAsset({
-    name,
+      asset_id: currentAsset.id || 1,
-    file
+      owner,
+      repo,
     });
+  }
+  console.log(`⬆️ Uploading ${name}...`);
+  const endpoint = new URL(url);
+  endpoint.searchParams.append("name", name);
+  const resp = await github.request({
+    method: "POST",
+    url: endpoint.toString(),
+    headers: {
+      "content-length": `${size}`,
+      "content-type": mime,
+      authorization: `token ${config.github_token}`,
+    },
+    data: body,
+  });
+  const json = resp.data;
+  if (resp.status !== 201) {
+    throw new Error(
+      `Failed to upload release asset ${name}. received status code ${
+        resp.status
+      }\n${json.message}\n${JSON.stringify(json.errors)}`
+    );
+  }
+  return json;
 };
 
 export const release = async (
@@ -154,16 +195,22 @@ export const release = async (
 
   const [owner, repo] = config.github_repository.split("/");
   const tag =
-    config.input_tag_name || config.github_ref.replace("refs/tags/", "");
+    config.input_tag_name ||
+    (isTag(config.github_ref)
+      ? config.github_ref.replace("refs/tags/", "")
+      : "");
+
+  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
     if (config.input_draft) {
       for await (const response of releaser.allReleases({
         owner,
-        repo
+        repo,
       })) {
-        let release = response.data.find(release => release.tag_name === tag);
+        let release = response.data.find((release) => release.tag_name === tag);
         if (release) {
           return release;
         }
@@ -172,7 +219,7 @@ export const release = async (
     let existingRelease = await releaser.getReleaseByTag({
       owner,
       repo,
-      tag
+      tag,
     });
 
     const release_id = existingRelease.data.id;
@@ -191,12 +238,18 @@ export const release = async (
 
     const tag_name = tag;
     const name = config.input_name || existingRelease.data.name || tag;
-
+    // revisit: support a new body-concat-strategy input for accumulating
-    let body: string = "";
+    // body parts as a release gets updated. some users will likely want this while
-    if (existingRelease.data.body) body += existingRelease.data.body;
+    // others won't previously this was duplicating content for most which
-    let workflowBody = releaseBody(config);
+    // no one wants
-    if (existingRelease.data.body && workflowBody) body += "\n";
+    const workflowBody = releaseBody(config) || "";
-    if (workflowBody) body += workflowBody;
+    const existingReleaseBody = existingRelease.data.body || "";
+    let body: string;
+    if (config.input_append_body && workflowBody && existingReleaseBody) {
+      body = existingReleaseBody + "\n" + workflowBody;
+    } else {
+      body = workflowBody || existingReleaseBody;
+    }
 
     const draft =
       config.input_draft !== undefined
@@ -207,6 +260,8 @@ export const release = async (
         ? config.input_prerelease
         : existingRelease.data.prerelease;
 
+    const make_latest = config.input_make_latest;
+
     const release = await releaser.updateRelease({
       owner,
       repo,
@@ -216,7 +271,10 @@ export const release = async (
       name,
       body,
       draft,
-      prerelease
+      prerelease,
+      discussion_category_name,
+      generate_release_notes,
+      make_latest,
     });
     return release.data;
   } catch (error) {
@@ -227,6 +285,7 @@ export const release = async (
       const draft = config.input_draft;
       const prerelease = config.input_prerelease;
       const target_commitish = config.input_target_commitish;
+      const make_latest = config.input_make_latest;
       let commitMessage: string = "";
       if (target_commitish) {
         commitMessage = ` using commit "${target_commitish}"`;
@@ -243,7 +302,10 @@ export const release = async (
           body,
           draft,
           prerelease,
-          target_commitish
+          target_commitish,
+          discussion_category_name,
+          generate_release_notes,
+          make_latest,
         });
         return release.data;
       } catch (error) {
@@ -251,7 +313,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/main.ts

@@ -1,29 +1,48 @@
-import { paths, parseConfig, isTag, unmatchedPatterns } from "./util";
+import {
+  paths,
+  parseConfig,
+  isTag,
+  unmatchedPatterns,
+  uploadUrl,
+} from "./util";
 import { release, upload, GitHubReleaser } from "./github";
+import { getOctokit } from "@actions/github";
 import { setFailed, setOutput } from "@actions/core";
-import { GitHub } from "@actions/github";
+import { GitHub, getOctokitOptions } from "@actions/github/lib/utils";
+
 import { env } from "process";
 
 async function run() {
   try {
     const config = parseConfig(env);
-    if (!config.input_tag_name && !isTag(config.github_ref)) {
+    if (
+      !config.input_tag_name &&
+      !isTag(config.github_ref) &&
+      !config.input_draft
+    ) {
       throw new Error(`⚠️ GitHub Releases requires a tag`);
     }
     if (config.input_files) {
       const patterns = unmatchedPatterns(config.input_files);
-      patterns.forEach(pattern =>
+      patterns.forEach((pattern) => {
-        console.warn(`🤔 Pattern '${pattern}' does not match any files.`)
+        if (config.input_fail_on_unmatched_files) {
-      );
+          throw new Error(`⚠️  Pattern '${pattern}' does not match any files.`);
+        } else {
+          console.warn(`🤔 Pattern '${pattern}' does not match any files.`);
+        }
+      });
       if (patterns.length > 0 && config.input_fail_on_unmatched_files) {
         throw new Error(`⚠️ There were unmatched files`);
       }
     }
-    GitHub.plugin([
+
-      require("@octokit/plugin-throttling"),
+    // const oktokit = GitHub.plugin(
-      require("@octokit/plugin-retry")
+    //   require("@octokit/plugin-throttling"),
-    ]);
+    //   require("@octokit/plugin-retry")
-    const gh = new GitHub(config.github_token, {
+    // );
+
+    const gh = getOctokit(config.github_token, {
+      //new oktokit(
       throttle: {
         onRateLimit: (retryAfter, options) => {
           console.warn(
@@ -40,18 +59,33 @@ async function run() {
           console.warn(
             `Abuse detected for request ${options.method} ${options.url}`
           );
-        }
+        },
-      }
+      },
     });
-    let rel = await release(config, new GitHubReleaser(gh));
+    //);
-    if (config.input_files) {
+    const rel = await release(config, new GitHubReleaser(gh));
+    if (config.input_files && config.input_files.length > 0) {
       const files = paths(config.input_files);
       if (files.length == 0) {
-        console.warn(`🤔 ${config.input_files} not include valid file.`);
+        throw new Error(`⚠️ ${config.input_files} not include valid file.`);
       }
-      files.forEach(async path => {
+      const currentAssets = rel.assets;
-        await upload(gh, rel.upload_url, path);
+      const assets = await Promise.all(
+        files.map(async (path) => {
+          const json = await upload(
+            config,
+            gh,
+            uploadUrl(rel.upload_url),
+            path,
+            currentAssets
+          );
+          delete json.uploader;
+          return json;
+        })
+      ).catch((error) => {
+        throw error;
       });
+      setOutput("assets", assets);
     }
     console.log(`🎉 Release ready at ${rel.html_url}`);
     setOutput("url", rel.html_url);

src/util.ts

@@ -1,5 +1,5 @@
 import * as glob from "glob";
-import { lstatSync, readFileSync } from "fs";
+import { statSync, readFileSync } from "fs";
 
 export interface Config {
   github_token: string;
@@ -16,8 +16,20 @@ export interface Config {
   input_prerelease?: boolean;
   input_fail_on_unmatched_files?: boolean;
   input_target_commitish?: string;
+  input_discussion_category_name?: string;
+  input_generate_release_notes?: boolean;
+  input_append_body?: boolean;
+  input_make_latest: string | undefined;
 }
 
+export const uploadUrl = (url: string): string => {
+  const templateMarkerPos = url.indexOf("{");
+  if (templateMarkerPos > -1) {
+    return url.substring(0, templateMarkerPos);
+  }
+  return url;
+};
+
 export const releaseBody = (config: Config): string | undefined => {
   return (
     (config.input_body_path &&
@@ -33,19 +45,19 @@ export const parseInputFiles = (files: string): string[] => {
     (acc, line) =>
       acc
         .concat(line.split(","))
-        .filter(pat => pat)
+        .filter((pat) => pat)
-        .map(pat => pat.trim()),
+        .map((pat) => pat.trim()),
     []
   );
 };
 
 export const parseConfig = (env: Env): Config => {
   return {
-    github_token: env.GITHUB_TOKEN || "",
+    github_token: env.GITHUB_TOKEN || env.INPUT_TOKEN || "",
     github_ref: env.GITHUB_REF || "",
     github_repository: env.INPUT_REPOSITORY || env.GITHUB_REPOSITORY || "",
     input_name: env.INPUT_NAME,
-    input_tag_name: env.INPUT_TAG_NAME,
+    input_tag_name: env.INPUT_TAG_NAME?.trim(),
     input_body: env.INPUT_BODY,
     input_body_path: env.INPUT_BODY_PATH,
     input_files: parseInputFiles(env.INPUT_FILES || ""),
@@ -54,14 +66,21 @@ 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,
+    input_generate_release_notes: env.INPUT_GENERATE_RELEASE_NOTES == "true",
+    input_append_body: env.INPUT_APPEND_BODY == "true",
+    input_make_latest: env.INPUT_MAKE_LATEST
+      ? env.INPUT_MAKE_LATEST
+      : undefined,
   };
 };
 
 export const paths = (patterns: string[]): string[] => {
   return patterns.reduce((acc: string[], pattern: string): string[] => {
     return acc.concat(
-      glob.sync(pattern).filter(path => lstatSync(path).isFile())
+      glob.sync(pattern).filter((path) => statSync(path).isFile())
     );
   }, []);
 };
@@ -69,7 +88,7 @@ export const paths = (patterns: string[]): string[] => {
 export const unmatchedPatterns = (patterns: string[]): string[] => {
   return patterns.reduce((acc: string[], pattern: string): string[] => {
     return acc.concat(
-      glob.sync(pattern).filter(path => lstatSync(path).isFile()).length == 0
+      glob.sync(pattern).filter((path) => statSync(path).isFile()).length == 0
         ? [pattern]
         : []
     );

tsconfig.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "useUnknownInCatchVariables": false,
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
     "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */