build

* followup to #417

* update changelog

.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
@@ -23,4 +23,4 @@ jobs:
       #     git diff --exit-code --stat -- . ':!node_modules' \
       #     || (echo "##[error] found changed files after build. please 'npm run build && npm run fmt'" \
       #             "and check in all changes" \
-      #         && exit 1)
+      #         && exit 1)

.nvmrc

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

CHANGELOG.md

@@ -1,3 +1,49 @@
+## 2.0.4
+
+- Minor follow up to [#417](https://github.com/softprops/action-gh-release/pull/417). [#425](https://github.com/softprops/action-gh-release/pull/425)
+
+## 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

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

@@ -41,9 +41,9 @@ 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/')
 ```
 
@@ -62,9 +62,9 @@ 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
 ```
 
 ### ⬆️ Uploading release assets
@@ -88,13 +88,13 @@ 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
@@ -112,13 +112,13 @@ 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: |
@@ -126,7 +126,9 @@ jobs:
             LICENSE
 ```
 
-> **⚠️ 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
 
@@ -144,11 +146,11 @@ 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.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.workspace }}-CHANGELOG.txt
@@ -165,20 +167,23 @@ 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. 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.
@@ -191,11 +196,14 @@ 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 |
+| 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
 
@@ -208,4 +216,26 @@ 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
+```
+
+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__/util.test.ts

@@ -5,13 +5,13 @@ import {
   parseConfig,
   parseInputFiles,
   unmatchedPatterns,
-  uploadUrl
+  uploadUrl,
 } from "../src/util";
 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,9 @@ 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,
+          input_make_latest: undefined,
         })
       );
     });
@@ -69,7 +71,9 @@ 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,
+          input_make_latest: undefined,
         })
       );
     });
@@ -88,39 +92,57 @@ 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,
+          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,
-        input_discussion_category_name: undefined
-      });
-    });
-
-    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,
+          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,
+        }
+      );
+    });
+
+    it("parses basic config with commitish", () => {
+      assert.deepStrictEqual(
+        parseConfig({
+          INPUT_TARGET_COMMITISH: "affa18ef97bc9db20076945705aba8c516139abd",
+        }),
+        {
+          github_ref: "",
+          github_repository: "",
+          github_token: "",
+          input_append_body: false,
           input_body: undefined,
           input_body_path: undefined,
           input_draft: undefined,
@@ -130,19 +152,22 @@ 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,
+          input_make_latest: undefined,
         }
       );
     });
     it("supports discussion category names", () => {
       assert.deepStrictEqual(
         parseConfig({
-          INPUT_DISCUSSION_CATEGORY_NAME: "releases"
+          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,
@@ -152,22 +177,52 @@ 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,
+          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"
+          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,
@@ -177,7 +232,9 @@ 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,
+          input_make_latest: undefined,
         }
       );
     });
@@ -186,12 +243,13 @@ describe("util", () => {
         parseConfig({
           INPUT_DRAFT: "false",
           INPUT_PRERELEASE: "true",
-          INPUT_TOKEN: "input-token"
+          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,
@@ -201,7 +259,9 @@ 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,
+          input_make_latest: undefined,
         }
       );
     });
@@ -209,12 +269,13 @@ describe("util", () => {
       assert.deepStrictEqual(
         parseConfig({
           INPUT_DRAFT: "false",
-          INPUT_PRERELEASE: "true"
+          INPUT_PRERELEASE: "true",
         }),
         {
           github_ref: "",
           github_repository: "",
           github_token: "",
+          input_append_body: false,
           input_body: undefined,
           input_body_path: undefined,
           input_draft: false,
@@ -224,7 +285,59 @@ 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,
+          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

@@ -40,6 +40,15 @@ 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
+  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"
 outputs:
@@ -49,8 +58,10 @@ outputs:
     description: "Release ID"
   upload_url:
     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"
 branding:
   color: "green"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "action-gh-release",
-  "version": "0.1.10",
+  "version": "2.0.3",
   "private": true,
   "description": "GitHub Action for creating GitHub Releases",
   "main": "lib/main.js",
@@ -8,38 +8,36 @@
     "build": "ncc build src/main.ts --minify",
     "test": "jest",
     "fmt": "prettier --write \"src/**/*.ts\" \"__tests__/**/*.ts\"",
-    "fmtcheck": "prettier --check \"src/**/*.ts\" \"__tests__/**/*.ts\""
+    "fmtcheck": "prettier --check \"src/**/*.ts\" \"__tests__/**/*.ts\"",
+    "updatetag": "git tag -d v2 && git push origin :v2 && git tag -a v2 -m '' && git push origin v2"
   },
   "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.4.0",
-    "@actions/github": "^5.0.0",
-    "@octokit/plugin-retry": "^3.0.9",
-    "@octokit/plugin-throttling": "^3.5.1",
-    "glob": "^7.1.6",
-    "mime": "^2.4.4",
-    "node-fetch": "^2.6.1"
+    "@actions/core": "^1.10.0",
+    "@actions/github": "^5.1.1",
+    "@octokit/plugin-retry": "^4.0.3",
+    "@octokit/plugin-throttling": "^4.3.2",
+    "glob": "^8.0.3",
+    "mime": "^3.0.0"
   },
   "devDependencies": {
-    "@types/glob": "^7.1.1",
-    "@types/jest": "^24.0.25",
-    "@types/mime": "^2.0.1",
-    "@types/node": "^12.12.24",
-    "@types/node-fetch": "^2.5.12",
-    "@zeit/ncc": "^0.21.0",
-    "jest": "^24.9.0",
-    "jest-circus": "^24.9.0",
-    "prettier": "1.19.1",
-    "ts-jest": "^24.2.0",
-    "typescript": "^3.7.4",
+    "@types/glob": "^8.0.0",
+    "@types/jest": "^29.2.3",
+    "@types/mime": "^3.0.1",
+    "@types/node": "^18.11.9",
+    "@vercel/ncc": "^0.34.0",
+    "jest": "^29.3.1",
+    "jest-circus": "^29.3.1",
+    "prettier": "2.8.0",
+    "ts-jest": "^29.0.3",
+    "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,7 +1,6 @@
-import fetch from "node-fetch";
 import { GitHub } from "@actions/github/lib/utils";
 import { Config, isTag, releaseBody } from "./util";
-import { lstatSync, readFileSync } from "fs";
+import { statSync, readFileSync } from "fs";
 import { getType } from "mime";
 import { basename } from "path";
 
@@ -44,6 +43,8 @@ export interface Releaser {
     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: {
@@ -57,6 +58,8 @@ export interface Releaser {
     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: {
@@ -89,6 +92,8 @@ export class GitHubReleaser implements Releaser {
     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.rest.repos.createRelease(params);
   }
@@ -104,6 +109,8 @@ export class GitHubReleaser implements Releaser {
     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.rest.repos.updateRelease(params);
   }
@@ -123,8 +130,8 @@ export const asset = (path: string): ReleaseAsset => {
   return {
     name: basename(path),
     mime: mimeOrDefault(path),
-    size: lstatSync(path).size,
-    data: readFileSync(path)
+    size: statSync(path).size,
+    data: readFileSync(path),
   };
 };
 
@@ -149,25 +156,26 @@ export const upload = async (
     await github.rest.repos.deleteReleaseAsset({
       asset_id: currentAsset.id || 1,
       owner,
-      repo
+      repo,
     });
   }
   console.log(`⬆️ Uploading ${name}...`);
   const endpoint = new URL(url);
   endpoint.searchParams.append("name", name);
-  const resp = await fetch(endpoint, {
+  const resp = await github.request({
+    method: "POST",
+    url: endpoint.toString(),
     headers: {
       "content-length": `${size}`,
       "content-type": mime,
-      authorization: `token ${config.github_token}`
+      authorization: `token ${config.github_token}`,
     },
-    method: "POST",
-    body
+    data: body,
   });
-  const json = await resp.json();
+  const json = resp.data;
   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,15 +201,16 @@ 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
     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;
         }
@@ -210,7 +219,7 @@ export const release = async (
     let existingRelease = await releaser.getReleaseByTag({
       owner,
       repo,
-      tag
+      tag,
     });
 
     const release_id = existingRelease.data.id;
@@ -229,12 +238,18 @@ 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
+    const workflowBody = releaseBody(config) || "";
+    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
@@ -245,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,
@@ -255,7 +272,9 @@ export const release = async (
       body,
       draft,
       prerelease,
-      discussion_category_name
+      discussion_category_name,
+      generate_release_notes,
+      make_latest,
     });
     return release.data;
   } catch (error) {
@@ -266,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}"`;
@@ -283,7 +303,9 @@ export const release = async (
           draft,
           prerelease,
           target_commitish,
-          discussion_category_name
+          discussion_category_name,
+          generate_release_notes,
+          make_latest,
         });
         return release.data;
       } catch (error) {
@@ -291,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

@@ -3,7 +3,7 @@ import {
   parseConfig,
   isTag,
   unmatchedPatterns,
-  uploadUrl
+  uploadUrl,
 } from "./util";
 import { release, upload, GitHubReleaser } from "./github";
 import { getOctokit } from "@actions/github";
@@ -24,9 +24,13 @@ async function run() {
     }
     if (config.input_files) {
       const patterns = unmatchedPatterns(config.input_files);
-      patterns.forEach(pattern =>
-        console.warn(`🤔 Pattern '${pattern}' does not match any files.`)
-      );
+      patterns.forEach((pattern) => {
+        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`);
       }
@@ -55,30 +59,37 @@ async function run() {
           console.warn(
             `Abuse detected for request ${options.method} ${options.url}`
           );
-        }
-      }
+        },
+      },
     });
     //);
     const rel = await release(config, new GitHubReleaser(gh));
-    if (config.input_files) {
+    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.`);
+        if (config.input_fail_on_unmatched_files) {
+          throw new Error(`⚠️ ${config.input_files} not include valid file.`);
+        } else {
+          console.warn(`🤔 ${config.input_files} not include valid file.`);
+        }
       }
-      const currentAsserts = rel.assets;
-      await Promise.all(
-        files.map(async path => {
-          await upload(
+      const currentAssets = rel.assets;
+      const assets = await Promise.all(
+        files.map(async (path) => {
+          const json = await upload(
             config,
             gh,
             uploadUrl(rel.upload_url),
             path,
-            currentAsserts
+            currentAssets
           );
+          delete json.uploader;
+          return json;
         })
-      ).catch(error => {
+      ).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;
@@ -17,6 +17,9 @@ export interface Config {
   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 => {
@@ -42,8 +45,8 @@ export const parseInputFiles = (files: string): string[] => {
     (acc, line) =>
       acc
         .concat(line.split(","))
-        .filter(pat => pat)
-        .map(pat => pat.trim()),
+        .filter((pat) => pat)
+        .map((pat) => pat.trim()),
     []
   );
 };
@@ -63,15 +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_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",
+    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())
     );
   }, []);
 };
@@ -79,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'. */