release 2.4.0

Signed-off-by: Rui Chen <rui@chenrui.dev>

.github/dependabot.yml

@@ -0,0 +1,29 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: weekly
+    groups:
+      npm:
+        patterns:
+          - "*"
+    ignore:
+      - dependency-name: node-fetch
+        versions:
+          - ">=3.0.0"
+      - dependency-name: "@types/node"
+        versions:
+          - ">=22.0.0"
+    commit-message:
+      prefix: "chore(deps)"
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+    commit-message:
+      prefix: "chore(deps)"

.github/release.yml

@@ -0,0 +1,22 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+      - github-actions
+    authors:
+      - octocat
+      - renovate[bot]
+  categories:
+    - title: Breaking Changes 🛠
+      labels:
+        - breaking-change
+    - title: Exciting New Features 🎉
+      labels:
+        - enhancement
+        - feature
+    - title: Bug fixes 🐛
+      labels:
+        - bug
+    - title: Other Changes 🔄
+      labels:
+        - "*"

.github/workflows/main.yml

@@ -1,14 +1,20 @@
-name: Main
+name: main
 
-on: [pull_request, push]
+on:
+  push:
+  pull_request:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
-      # https://github.com/actions/checkout
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
-      - name: Checkout
+
-        uses: actions/checkout@v2
+      - uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v4
+        with:
+          node-version-file: ".tool-versions"
+          cache: "npm"
+
       - name: Install
         run: npm ci
       - name: Build
@@ -23,4 +29,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)

.gitignore

@@ -2,3 +2,4 @@ __tests__/runner/*
 # 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
 node_modules
+coverage

.prettierignore

@@ -0,0 +1,16 @@
+# Build outputs
+dist/
+lib/
+coverage/
+
+# Dependencies
+node_modules/
+
+# Misc
+.github/
+*.log
+.DS_Store
+__tests__/release.txt
+
+# Package files
+package-lock.json

.prettierrc.js

@@ -0,0 +1,11 @@
+/**
+ * @type {import('prettier').Config}
+ */
+module.exports = {
+  trailingComma: 'all',
+  tabWidth: 2,
+  semi: true,
+  singleQuote: true,
+  printWidth: 100,
+  bracketSpacing: true,
+};

.tool-versions

@@ -0,0 +1 @@
+nodejs 24.2.0

CHANGELOG.md

@@ -1,6 +1,198 @@
+## 2.4.0
+
+## What's Changed
+
+### Exciting New Features 🎉
+
+* feat(action): respect working_directory for files globs by @stephenway in https://github.com/softprops/action-gh-release/pull/667
+
+## 2.3.4
+
+## What's Changed
+
+### Bug fixes 🐛
+
+* fix(action): handle 422 already_exists race condition by @stephenway in https://github.com/softprops/action-gh-release/pull/665
+
+### Other Changes 🔄
+
+- dependency updates
+
+## 2.3.3
+
+## What's Changed
+
+### Exciting New Features 🎉
+
+* feat: add input option `overwrite_files` by @asfernandes in https://github.com/softprops/action-gh-release/pull/343
+
+### Other Changes 🔄
+
+- dependency updates
+
+## 2.3.2
+
+* fix: revert fs `readableWebStream` change
+
+## 2.3.1
+
+### Bug fixes 🐛
+
+* fix: fix file closing issue by @WailGree in https://github.com/softprops/action-gh-release/pull/629
+
+## 2.3.0
+
+* Migrate from jest to vitest
+* Replace `mime` with `mime-types`
+* Bump to use node 24
+* Dependency updates
+
+## 2.2.2
+
+## What's Changed
+
+### Bug fixes 🐛
+
+* fix: updating release draft status from true to false by @galargh in https://github.com/softprops/action-gh-release/pull/316
+
+### Other Changes 🔄
+
+* chore: simplify ref_type test by @steinybot in https://github.com/softprops/action-gh-release/pull/598
+* fix(docs): clarify the default for tag_name by @muzimuzhi in https://github.com/softprops/action-gh-release/pull/599
+* test(release): add unit tests when searching for a release by @rwaskiewicz in https://github.com/softprops/action-gh-release/pull/603
+* dependency updates
+
+## 2.2.1
+
+## What's Changed
+
+### Bug fixes 🐛
+
+* fix: big file uploads by @xen0n in https://github.com/softprops/action-gh-release/pull/562
+
+### Other Changes 🔄
+* chore(deps): bump @types/node from 22.10.1 to 22.10.2 by @dependabot in https://github.com/softprops/action-gh-release/pull/559
+* chore(deps): bump @types/node from 22.10.2 to 22.10.5 by @dependabot in https://github.com/softprops/action-gh-release/pull/569
+* chore: update error and warning messages for not matching files in files field by @ytimocin in https://github.com/softprops/action-gh-release/pull/568
+
+## 2.2.0
+
+## What's Changed
+
+### Exciting New Features 🎉
+
+* feat: read the release assets asynchronously by @xen0n in https://github.com/softprops/action-gh-release/pull/552
+
+### Bug fixes 🐛
+
+* fix(docs): clarify the default for tag_name by @alexeagle in https://github.com/softprops/action-gh-release/pull/544
+
+### Other Changes 🔄
+
+* chore(deps): bump typescript from 5.6.3 to 5.7.2 by @dependabot in https://github.com/softprops/action-gh-release/pull/548
+* chore(deps): bump @types/node from 22.9.0 to 22.9.4 by @dependabot in https://github.com/softprops/action-gh-release/pull/547
+* chore(deps): bump cross-spawn from 7.0.3 to 7.0.6 by @dependabot in https://github.com/softprops/action-gh-release/pull/545
+* chore(deps): bump @vercel/ncc from 0.38.2 to 0.38.3 by @dependabot in https://github.com/softprops/action-gh-release/pull/543
+* chore(deps): bump prettier from 3.3.3 to 3.4.1 by @dependabot in https://github.com/softprops/action-gh-release/pull/550
+* chore(deps): bump @types/node from 22.9.4 to 22.10.1 by @dependabot in https://github.com/softprops/action-gh-release/pull/551
+* chore(deps): bump prettier from 3.4.1 to 3.4.2 by @dependabot in https://github.com/softprops/action-gh-release/pull/554
+
+## 2.1.0
+
+## What's Changed
+
+### Exciting New Features 🎉
+* feat: add support for release assets with multiple spaces within the name by @dukhine in https://github.com/softprops/action-gh-release/pull/518
+* feat: preserve upload order by @richarddd in https://github.com/softprops/action-gh-release/pull/500
+
+### Other Changes 🔄
+* chore(deps): bump @types/node from 22.8.2 to 22.8.7 by @dependabot in https://github.com/softprops/action-gh-release/pull/539
+
+## 2.0.9
+
+- maintenance release with updated dependencies
+
+## 2.0.8
+
+### Other Changes 🔄
+* chore(deps): bump prettier from 2.8.0 to 3.3.3 by @dependabot in https://github.com/softprops/action-gh-release/pull/480
+* chore(deps): bump @types/node from 20.14.9 to 20.14.11 by @dependabot in https://github.com/softprops/action-gh-release/pull/483
+* chore(deps): bump @octokit/plugin-throttling from 9.3.0 to 9.3.1 by @dependabot in https://github.com/softprops/action-gh-release/pull/484
+* chore(deps): bump glob from 10.4.2 to 11.0.0 by @dependabot in https://github.com/softprops/action-gh-release/pull/477
+* refactor: write jest config in ts by @chenrui333 in https://github.com/softprops/action-gh-release/pull/485
+* chore(deps): bump @actions/github from 5.1.1 to 6.0.0 by @dependabot in https://github.com/softprops/action-gh-release/pull/470
+
+## 2.0.7
+
+### Bug fixes 🐛
+
+* Fix missing update release body by @FirelightFlagboy in https://github.com/softprops/action-gh-release/pull/365
+
+### Other Changes 🔄
+
+* Bump @octokit/plugin-retry from 4.0.3 to 7.1.1 by @dependabot in https://github.com/softprops/action-gh-release/pull/443
+* Bump typescript from 4.9.5 to 5.5.2 by @dependabot in https://github.com/softprops/action-gh-release/pull/467
+* Bump @types/node from 20.14.6 to 20.14.8 by @dependabot in https://github.com/softprops/action-gh-release/pull/469
+* Bump @types/node from 20.14.8 to 20.14.9 by @dependabot in https://github.com/softprops/action-gh-release/pull/473
+* Bump typescript from 5.5.2 to 5.5.3 by @dependabot in https://github.com/softprops/action-gh-release/pull/472
+* Bump ts-jest from 29.1.5 to 29.2.2 by @dependabot in https://github.com/softprops/action-gh-release/pull/479
+* docs: document that existing releases are updated by @jvanbruegge in https://github.com/softprops/action-gh-release/pull/474
+
+## 2.0.6
+
+- maintenance release with updated dependencies
+
+## 2.0.5
+
+- Factor in file names with spaces when upserting files [#446](https://github.com/softprops/action-gh-release/pull/446) via [@MystiPanda](https://github.com/MystiPanda)
+- Improvements to error handling [#449](https://github.com/softprops/action-gh-release/pull/449) via [@till](https://github.com/till)
+
+## 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

@@ -21,6 +21,16 @@
 
 <br />
 
+- [🤸 Usage](#-usage)
+  - [🚥 Limit releases to pushes to tags](#-limit-releases-to-pushes-to-tags)
+  - [⬆️ Uploading release assets](#️-uploading-release-assets)
+  - [📝 External release notes](#-external-release-notes)
+  - [💅 Customizing](#-customizing)
+    - [inputs](#inputs)
+    - [outputs](#outputs)
+    - [environment variables](#environment-variables)
+  - [Permissions](#permissions)
+
 ## 🤸 Usage
 
 ### 🚥 Limit releases to pushes to tags
@@ -41,10 +51,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
       - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
-        if: startsWith(github.ref, 'refs/tags/')
+        if: github.ref_type == 'tag'
 ```
 
 You can also use push config tag filter
@@ -62,9 +72,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
       - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
 ```
 
 ### ⬆️ Uploading release assets
@@ -75,6 +85,7 @@ GitHub release and all are optional.
 A common case for GitHub releases is to upload your binary after its been validated and packaged.
 Use the `with.files` input to declare a newline-delimited list of glob expressions matching the files
 you wish to upload to GitHub releases. If you'd like you can just list the files by name directly.
+If a tag already has a GitHub release, the existing release will be updated with the release assets.
 
 Below is an example of uploading a single asset named `Release.txt`
 
@@ -88,14 +99,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
       - 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/')
+        if: github.ref_type == 'tag'
         with:
           files: Release.txt
 ```
@@ -112,21 +123,23 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
       - 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/')
+        if: github.ref_type == 'tag'
         with:
           files: |
             Release.txt
             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,19 +157,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
       - 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/')
+        if: github.ref_type == 'tag'
         with:
           body_path: ${{ github.workspace }}-CHANGELOG.txt
+          repository: my_gh_org/my_gh_repo
           # note you'll typically need to create a personal access token
           # with permissions to create releases in the other repo
           token: ${{ secrets.CUSTOM_GITHUB_TOKEN }}
-        env:
-          GITHUB_REPOSITORY: my_gh_org/my_gh_repo
 ```
 
 ### 💅 Customizing
@@ -165,20 +177,25 @@ jobs:
 
 The following are optional as `step.with` keys
 
-| Name                       | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                 |
+| Name                       | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                     |
-| -------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| -------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `body`                     | String  | Text communicating notable changes in this release                                                                                                                                                                                                                                                                                                                                          |
+| `body`                     | String  | Text communicating notable changes in this release                                                                                                                                                                                                                                                                                                                                                                                              |
-| `body_path`                | String  | Path to load 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                                                                                                                                                                                                                                                                                                                                         |
+| `draft`                    | Boolean | Indicator of whether or not this release is a draft                                                                                                                                                                                                                                                                                                                                                                                             |
-| `prerelease`               | Boolean | Indicator of whether or not is a prerelease                                                                                                                                                                                                                                                                                                                                                 |
+| `prerelease`               | Boolean | Indicator of whether or not is a prerelease                                                                                                                                                                                                                                                                                                                                                                                                     |
-| `files`                    | String  | Newline-delimited globs of paths to assets to upload for release                                                                                                                                                                                                                                                                                                                            |
+| `preserve_order`           | Boolean | Indicator of whether order of files should be preserved when uploading assets                                                                                                                                                                                                                                                                                                                                                                   |
-| `name`                     | String  | Name of the release. defaults to tag name                                                                                                                                                                                                                                                                                                                                                   |
+| `files`                    | String  | Newline-delimited globs of paths to assets to upload for release                                                                                                                                                                                                                                                                                                                                                                                |
-| `tag_name`                 | String  | Name of a tag. defaults to `github.ref`                                                                                                                                                                                                                                                                                                                                                     |
+| `overwrite_files`          | Boolean | Indicator of whether files should be overwritten when they already exist. Defaults to true                                                                                                                                                                                                                                                                                                                                                      |
-| `fail_on_unmatched_files`  | Boolean | Indicator of whether to fail if any of the `files` globs match nothing                                                                                                                                                                                                                                                                                                                      |
+| `name`                     | String  | Name of the release. defaults to tag name                                                                                                                                                                                                                                                                                                                                                                                                       |
-| `repository`               | String  | Name of a target repository in `<owner>/<repo>` format. Defaults to GITHUB_REPOSITORY env variable                                                                                                                                                                                                                                                                                          |
+| `tag_name`                 | String  | Name of a tag. defaults to `github.ref_name`                                                                                                                                                                                                                                                                                                                                                                                                         |
-| `target_commitish`         | String  | Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA.                                                                                                                                                                                                                                                                                         |
+| `fail_on_unmatched_files`  | Boolean | Indicator of whether to fail if any of the `files` globs match nothing                                                                                                                                                                                                                                                                                                                                                                          |
-| `token`                    | String  | Secret GitHub Personal Access Token. Defaults to `${{ github.token }}`                                                                                                                                                                                                                                                                                                                      |
+| `repository`               | String  | Name of a target repository in `<owner>/<repo>` format. Defaults to GITHUB_REPOSITORY env variable                                                                                                                                                                                                                                                                                                                                              |
-| `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) |
+| `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 +208,14 @@ release will retain its original info.
 
 The following outputs can be accessed via `${{ steps.<step-id>.outputs }}` from this action
 
-| Name         | Type   | Description                             |
+| Name         | Type   | Description                                                                                                                                                                               |
-| ------------ | ------ | --------------------------------------- |
+| ------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `url`        | String | Github.com URL for the release          |
+| `url`        | String | Github.com URL for the release                                                                                                                                                            |
-| `id`         | String | Release ID                              |
+| `id`         | String | Release ID                                                                                                                                                                                |
-| `upload_url` | String | URL for uploading assets to the release |
+| `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 +228,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__/github.test.ts

@@ -1,25 +1,308 @@
-//import * as assert from "assert";
+import {
-//const assert = require('assert');
+  asset,
-import * as assert from "assert";
+  findTagFromReleases,
-import { mimeOrDefault, asset } from "../src/github";
+  mimeOrDefault,
+  release,
+  Release,
+  Releaser,
+} from '../src/github';
 
-describe("github", () => {
+import { assert, describe, it } from 'vitest';
-  describe("mimeOrDefault", () => {
+
-    it("returns a specific mime for common path", async () => {
+describe('github', () => {
-      assert.equal(mimeOrDefault("foo.tar.gz"), "application/gzip");
+  describe('mimeOrDefault', () => {
+    it('returns a specific mime for common path', async () => {
+      assert.equal(mimeOrDefault('foo.tar.gz'), 'application/gzip');
     });
-    it("returns default mime for uncommon path", async () => {
+    it('returns default mime for uncommon path', async () => {
-      assert.equal(mimeOrDefault("foo.uncommon"), "application/octet-stream");
+      assert.equal(mimeOrDefault('foo.uncommon'), 'application/octet-stream');
     });
   });
 
-  describe("asset", () => {
+  describe('asset', () => {
-    it("derives asset info from a path", async () => {
+    it('derives asset info from a path', async () => {
-      const { name, mime, size, data } = asset("tests/data/foo/bar.txt");
+      const { name, mime, size } = asset('tests/data/foo/bar.txt');
-      assert.equal(name, "bar.txt");
+      assert.equal(name, 'bar.txt');
-      assert.equal(mime, "text/plain");
+      assert.equal(mime, 'text/plain');
       assert.equal(size, 10);
-      assert.equal(data.toString(), "release me");
+    });
+  });
+
+  describe('findTagFromReleases', () => {
+    const owner = 'owner';
+    const repo = 'repo';
+
+    const mockRelease: Release = {
+      id: 1,
+      upload_url: `https://api.github.com/repos/${owner}/${repo}/releases/1/assets`,
+      html_url: `https://github.com/${owner}/${repo}/releases/tag/v1.0.0`,
+      tag_name: 'v1.0.0',
+      name: 'Test Release',
+      body: 'Test body',
+      target_commitish: 'main',
+      draft: false,
+      prerelease: false,
+      assets: [],
+    } as const;
+
+    const mockReleaser: Releaser = {
+      getReleaseByTag: () => Promise.reject('Not implemented'),
+      createRelease: () => Promise.reject('Not implemented'),
+      updateRelease: () => Promise.reject('Not implemented'),
+      allReleases: async function* () {
+        yield { data: [mockRelease] };
+      },
+    } as const;
+
+    describe('when the tag_name is not an empty string', () => {
+      const targetTag = 'v1.0.0';
+
+      it('finds a matching release in first batch of results', async () => {
+        const targetRelease = {
+          ...mockRelease,
+          owner,
+          repo,
+          tag_name: targetTag,
+        };
+        const otherRelease = {
+          ...mockRelease,
+          owner,
+          repo,
+          tag_name: 'v1.0.1',
+        };
+
+        const releaser = {
+          ...mockReleaser,
+          allReleases: async function* () {
+            yield { data: [targetRelease] };
+            yield { data: [otherRelease] };
+          },
+        };
+
+        const result = await findTagFromReleases(releaser, owner, repo, targetTag);
+
+        assert.deepStrictEqual(result, targetRelease);
+      });
+
+      it('finds a matching release in second batch of results', async () => {
+        const targetRelease = {
+          ...mockRelease,
+          owner,
+          repo,
+          tag_name: targetTag,
+        };
+        const otherRelease = {
+          ...mockRelease,
+          owner,
+          repo,
+          tag_name: 'v1.0.1',
+        };
+
+        const releaser = {
+          ...mockReleaser,
+          allReleases: async function* () {
+            yield { data: [otherRelease] };
+            yield { data: [targetRelease] };
+          },
+        };
+
+        const result = await findTagFromReleases(releaser, owner, repo, targetTag);
+        assert.deepStrictEqual(result, targetRelease);
+      });
+
+      it('returns undefined when a release is not found in any batch', async () => {
+        const otherRelease = {
+          ...mockRelease,
+          owner,
+          repo,
+          tag_name: 'v1.0.1',
+        };
+        const releaser = {
+          ...mockReleaser,
+          allReleases: async function* () {
+            yield { data: [otherRelease] };
+            yield { data: [otherRelease] };
+          },
+        };
+
+        const result = await findTagFromReleases(releaser, owner, repo, targetTag);
+
+        assert.strictEqual(result, undefined);
+      });
+
+      it('returns undefined when no releases are returned', async () => {
+        const releaser = {
+          ...mockReleaser,
+          allReleases: async function* () {
+            yield { data: [] };
+          },
+        };
+
+        const result = await findTagFromReleases(releaser, owner, repo, targetTag);
+
+        assert.strictEqual(result, undefined);
+      });
+    });
+
+    describe('when the tag_name is an empty string', () => {
+      const emptyTag = '';
+
+      it('finds a matching release in first batch of results', async () => {
+        const targetRelease = {
+          ...mockRelease,
+          owner,
+          repo,
+          tag_name: emptyTag,
+        };
+        const otherRelease = {
+          ...mockRelease,
+          owner,
+          repo,
+          tag_name: 'v1.0.1',
+        };
+
+        const releaser = {
+          ...mockReleaser,
+          allReleases: async function* () {
+            yield { data: [targetRelease] };
+            yield { data: [otherRelease] };
+          },
+        };
+
+        const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
+
+        assert.deepStrictEqual(result, targetRelease);
+      });
+
+      it('finds a matching release in second batch of results', async () => {
+        const targetRelease = {
+          ...mockRelease,
+          owner,
+          repo,
+          tag_name: emptyTag,
+        };
+        const otherRelease = {
+          ...mockRelease,
+          owner,
+          repo,
+          tag_name: 'v1.0.1',
+        };
+
+        const releaser = {
+          ...mockReleaser,
+          allReleases: async function* () {
+            yield { data: [otherRelease] };
+            yield { data: [targetRelease] };
+          },
+        };
+
+        const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
+        assert.deepStrictEqual(result, targetRelease);
+      });
+
+      it('returns undefined when a release is not found in any batch', async () => {
+        const otherRelease = {
+          ...mockRelease,
+          owner,
+          repo,
+          tag_name: 'v1.0.1',
+        };
+        const releaser = {
+          ...mockReleaser,
+          allReleases: async function* () {
+            yield { data: [otherRelease] };
+            yield { data: [otherRelease] };
+          },
+        };
+
+        const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
+
+        assert.strictEqual(result, undefined);
+      });
+
+      it('returns undefined when no releases are returned', async () => {
+        const releaser = {
+          ...mockReleaser,
+          allReleases: async function* () {
+            yield { data: [] };
+          },
+        };
+
+        const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
+
+        assert.strictEqual(result, undefined);
+      });
+    });
+  });
+
+  describe('error handling', () => {
+    it('handles 422 already_exists error gracefully', async () => {
+      const mockReleaser: Releaser = {
+        getReleaseByTag: () => Promise.reject('Not implemented'),
+        createRelease: () =>
+          Promise.reject({
+            status: 422,
+            response: { data: { errors: [{ code: 'already_exists' }] } },
+          }),
+        updateRelease: () =>
+          Promise.resolve({
+            data: {
+              id: 1,
+              upload_url: 'test',
+              html_url: 'test',
+              tag_name: 'v1.0.0',
+              name: 'test',
+              body: 'test',
+              target_commitish: 'main',
+              draft: false,
+              prerelease: false,
+              assets: [],
+            },
+          }),
+        allReleases: async function* () {
+          yield {
+            data: [
+              {
+                id: 1,
+                upload_url: 'test',
+                html_url: 'test',
+                tag_name: 'v1.0.0',
+                name: 'test',
+                body: 'test',
+                target_commitish: 'main',
+                draft: false,
+                prerelease: false,
+                assets: [],
+              },
+            ],
+          };
+        },
+      } as const;
+
+      const config = {
+        github_token: 'test-token',
+        github_ref: 'refs/tags/v1.0.0',
+        github_repository: 'owner/repo',
+        input_tag_name: undefined,
+        input_name: undefined,
+        input_body: undefined,
+        input_body_path: undefined,
+        input_files: [],
+        input_draft: undefined,
+        input_prerelease: undefined,
+        input_preserve_order: undefined,
+        input_overwrite_files: undefined,
+        input_fail_on_unmatched_files: false,
+        input_target_commitish: undefined,
+        input_discussion_category_name: undefined,
+        input_generate_release_notes: false,
+        input_append_body: false,
+        input_make_latest: undefined,
+      };
+
+      const result = await release(config, mockReleaser, 1);
+      assert.ok(result);
+      assert.equal(result.id, 1);
     });
   });
 });

__tests__/util.test.ts

@@ -1,258 +1,434 @@
 import {
-  releaseBody,
+  alignAssetName,
   isTag,
-  paths,
   parseConfig,
   parseInputFiles,
+  paths,
+  releaseBody,
   unmatchedPatterns,
-  uploadUrl
+  uploadUrl,
-} from "../src/util";
+} from '../src/util';
-import * as assert from "assert";
 
-describe("util", () => {
+import { assert, describe, expect, it } from 'vitest';
-  describe("uploadUrl", () => {
+
-    it("stripts template", () => {
+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{?name,label}',
         ),
-        "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets"
+        'https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets',
       );
     });
   });
-  describe("parseInputFiles", () => {
+  describe('parseInputFiles', () => {
-    it("parses empty strings", () => {
+    it('parses empty strings', () => {
-      assert.deepStrictEqual(parseInputFiles(""), []);
+      assert.deepStrictEqual(parseInputFiles(''), []);
     });
-    it("parses comma-delimited strings", () => {
+    it('parses comma-delimited strings', () => {
-      assert.deepStrictEqual(parseInputFiles("foo,bar"), ["foo", "bar"]);
+      assert.deepStrictEqual(parseInputFiles('foo,bar'), ['foo', 'bar']);
     });
-    it("parses newline and comma-delimited (and then some)", () => {
+    it('parses newline and comma-delimited (and then some)', () => {
-      assert.deepStrictEqual(
+      assert.deepStrictEqual(parseInputFiles('foo,bar\nbaz,boom,\n\ndoom,loom '), [
-        parseInputFiles("foo,bar\nbaz,boom,\n\ndoom,loom "),
+        'foo',
-        ["foo", "bar", "baz", "boom", "doom", "loom"]
+        'bar',
-      );
+        'baz',
+        'boom',
+        'doom',
+        'loom',
+      ]);
     });
   });
-  describe("releaseBody", () => {
+  describe('releaseBody', () => {
-    it("uses input body", () => {
+    it('uses input body', () => {
       assert.equal(
-        "foo",
+        'foo',
         releaseBody({
-          github_ref: "",
+          github_ref: '',
-          github_repository: "",
+          github_repository: '',
-          github_token: "",
+          github_token: '',
-          input_body: "foo",
+          input_body: 'foo',
           input_body_path: undefined,
           input_draft: false,
           input_prerelease: false,
+          input_preserve_order: undefined,
           input_files: [],
+          input_overwrite_files: undefined,
           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,
+        }),
       );
     });
-    it("uses input body path", () => {
+    it('uses input body path', () => {
       assert.equal(
-        "bar",
+        'bar',
         releaseBody({
-          github_ref: "",
+          github_ref: '',
-          github_repository: "",
+          github_repository: '',
-          github_token: "",
+          github_token: '',
           input_body: undefined,
-          input_body_path: "__tests__/release.txt",
+          input_body_path: '__tests__/release.txt',
           input_draft: false,
           input_prerelease: false,
+          input_preserve_order: undefined,
           input_files: [],
+          input_overwrite_files: undefined,
           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,
+        }),
       );
     });
-    it("defaults to body path when both body and body path are provided", () => {
+    it('defaults to body path when both body and body path are provided', () => {
       assert.equal(
-        "bar",
+        'bar',
         releaseBody({
-          github_ref: "",
+          github_ref: '',
-          github_repository: "",
+          github_repository: '',
-          github_token: "",
+          github_token: '',
-          input_body: "foo",
+          input_body: 'foo',
-          input_body_path: "__tests__/release.txt",
+          input_body_path: '__tests__/release.txt',
           input_draft: false,
           input_prerelease: false,
+          input_preserve_order: undefined,
           input_files: [],
+          input_overwrite_files: undefined,
           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", () => {
+  describe('parseConfig', () => {
-    it("parses basic config", () => {
+    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_ref: '',
-          github_repository: "",
+          github_repository: '',
-          github_token: "",
+          github_token: '',
+          input_working_directory: undefined,
+          input_append_body: false,
+          input_body: undefined,
+          input_body_path: undefined,
+          input_draft: undefined,
+          input_prerelease: undefined,
+          input_preserve_order: undefined,
+          input_files: [],
+          input_overwrite_files: undefined,
+          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_working_directory: undefined,
+          input_append_body: false,
           input_body: undefined,
           input_body_path: undefined,
           input_draft: undefined,
           input_prerelease: undefined,
           input_files: [],
+          input_overwrite_files: undefined,
+          input_preserve_order: undefined,
           input_name: undefined,
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
-          input_target_commitish: "affa18ef97bc9db20076945705aba8c516139abd",
+          input_target_commitish: 'affa18ef97bc9db20076945705aba8c516139abd',
-          input_discussion_category_name: undefined
+          input_discussion_category_name: undefined,
-        }
+          input_generate_release_notes: false,
+          input_make_latest: undefined,
+        },
       );
     });
-    it("supports discussion category names", () => {
+    it('supports discussion category names', () => {
       assert.deepStrictEqual(
         parseConfig({
-          INPUT_DISCUSSION_CATEGORY_NAME: "releases"
+          INPUT_DISCUSSION_CATEGORY_NAME: 'releases',
         }),
         {
-          github_ref: "",
+          github_ref: '',
-          github_repository: "",
+          github_repository: '',
-          github_token: "",
+          github_token: '',
+          input_working_directory: undefined,
+          input_append_body: false,
           input_body: undefined,
           input_body_path: undefined,
           input_draft: undefined,
           input_prerelease: undefined,
           input_files: [],
+          input_preserve_order: undefined,
+          input_name: undefined,
+          input_overwrite_files: 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_working_directory: undefined,
+          input_append_body: false,
+          input_body: undefined,
+          input_body_path: undefined,
+          input_draft: undefined,
+          input_prerelease: undefined,
+          input_preserve_order: undefined,
+          input_files: [],
+          input_overwrite_files: undefined,
           input_name: undefined,
           input_tag_name: undefined,
           input_fail_on_unmatched_files: false,
           input_target_commitish: undefined,
-          input_discussion_category_name: "releases"
+          input_discussion_category_name: undefined,
-        }
+          input_generate_release_notes: true,
+          input_make_latest: undefined,
+        },
       );
     });
-    it("prefers GITHUB_TOKEN over token input for backwards compatibility", () => {
+
+    it('prefers GITHUB_TOKEN over token input for backwards compatibility', () => {
       assert.deepStrictEqual(
         parseConfig({
-          INPUT_DRAFT: "false",
+          INPUT_DRAFT: 'false',
-          INPUT_PRERELEASE: "true",
+          INPUT_PRERELEASE: 'true',
-          GITHUB_TOKEN: "env-token",
+          INPUT_PRESERVE_ORDER: 'true',
-          INPUT_TOKEN: "input-token"
+          GITHUB_TOKEN: 'env-token',
+          INPUT_TOKEN: 'input-token',
         }),
         {
-          github_ref: "",
+          github_ref: '',
-          github_repository: "",
+          github_repository: '',
-          github_token: "env-token",
+          github_token: 'env-token',
+          input_working_directory: undefined,
+          input_append_body: false,
           input_body: undefined,
           input_body_path: undefined,
           input_draft: false,
           input_prerelease: true,
+          input_preserve_order: true,
           input_files: [],
+          input_overwrite_files: undefined,
           input_name: undefined,
           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("uses input token as the source of GITHUB_TOKEN by default", () => {
+    it('uses input token as the source of GITHUB_TOKEN by default', () => {
       assert.deepStrictEqual(
         parseConfig({
-          INPUT_DRAFT: "false",
+          INPUT_DRAFT: 'false',
-          INPUT_PRERELEASE: "true",
+          INPUT_PRERELEASE: 'true',
-          INPUT_TOKEN: "input-token"
+          INPUT_TOKEN: 'input-token',
         }),
         {
-          github_ref: "",
+          github_ref: '',
-          github_repository: "",
+          github_repository: '',
-          github_token: "input-token",
+          github_token: 'input-token',
+          input_working_directory: undefined,
+          input_append_body: false,
           input_body: undefined,
           input_body_path: undefined,
           input_draft: false,
           input_prerelease: true,
+          input_preserve_order: undefined,
           input_files: [],
+          input_overwrite_files: undefined,
           input_name: undefined,
           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 with draft and prerelease", () => {
+    it('parses basic config with draft and prerelease', () => {
       assert.deepStrictEqual(
         parseConfig({
-          INPUT_DRAFT: "false",
+          INPUT_DRAFT: 'false',
-          INPUT_PRERELEASE: "true"
+          INPUT_PRERELEASE: 'true',
         }),
         {
-          github_ref: "",
+          github_ref: '',
-          github_repository: "",
+          github_repository: '',
-          github_token: "",
+          github_token: '',
+          input_working_directory: undefined,
+          input_append_body: false,
           input_body: undefined,
           input_body_path: undefined,
           input_draft: false,
           input_prerelease: true,
+          input_preserve_order: undefined,
           input_files: [],
+          input_overwrite_files: undefined,
           input_name: undefined,
           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_working_directory: undefined,
+          input_append_body: false,
+          input_body: undefined,
+          input_body_path: undefined,
+          input_draft: undefined,
+          input_prerelease: undefined,
+          input_preserve_order: undefined,
+          input_files: [],
+          input_name: undefined,
+          input_overwrite_files: 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_working_directory: undefined,
+          input_append_body: true,
+          input_body: undefined,
+          input_body_path: undefined,
+          input_draft: undefined,
+          input_prerelease: undefined,
+          input_preserve_order: undefined,
+          input_files: [],
+          input_overwrite_files: undefined,
+          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,
+        },
       );
     });
   });
-  describe("isTag", () => {
+  describe('isTag', () => {
-    it("returns true for tags", async () => {
+    it('returns true for tags', async () => {
-      assert.equal(isTag("refs/tags/foo"), true);
+      assert.equal(isTag('refs/tags/foo'), true);
     });
-    it("returns false for other kinds of refs", async () => {
+    it('returns false for other kinds of refs', async () => {
-      assert.equal(isTag("refs/heads/master"), false);
+      assert.equal(isTag('refs/heads/master'), false);
     });
   });
 
-  describe("paths", () => {
+  describe('paths', () => {
-    it("resolves files given a set of paths", async () => {
+    it('resolves files given a set of paths', async () => {
-      assert.deepStrictEqual(
+      assert.deepStrictEqual(paths(['tests/data/**/*', 'tests/data/does/not/exist/*']), [
-        paths(["tests/data/**/*", "tests/data/does/not/exist/*"]),
+        'tests/data/foo/bar.txt',
-        ["tests/data/foo/bar.txt"]
+      ]);
-      );
+    });
+
+    it('resolves files relative to working_directory', async () => {
+      assert.deepStrictEqual(paths(['data/**/*'], 'tests'), ['tests/data/foo/bar.txt']);
     });
   });
 
-  describe("unmatchedPatterns", () => {
+  describe('unmatchedPatterns', () => {
     it("returns the patterns that don't match any files", async () => {
       assert.deepStrictEqual(
-        unmatchedPatterns(["tests/data/**/*", "tests/data/does/not/exist/*"]),
+        unmatchedPatterns(['tests/data/**/*', 'tests/data/does/not/exist/*']),
-        ["tests/data/does/not/exist/*"]
+        ['tests/data/does/not/exist/*'],
       );
     });
+
+    it('resolves unmatched relative to working_directory', async () => {
+      assert.deepStrictEqual(unmatchedPatterns(['data/does/not/exist/*'], 'tests'), [
+        'data/does/not/exist/*',
+      ]);
+    });
+  });
+
+  describe('replaceSpacesWithDots', () => {
+    it('replaces all spaces with dots', () => {
+      expect(alignAssetName('John Doe.bla')).toBe('John.Doe.bla');
+    });
+
+    it('handles names with multiple spaces', () => {
+      expect(alignAssetName('John William Doe.bla')).toBe('John.William.Doe.bla');
+    });
+
+    it('returns the same string if there are no spaces', () => {
+      expect(alignAssetName('JohnDoe')).toBe('JohnDoe');
+    });
   });
 });

action.yml

@@ -13,7 +13,7 @@ inputs:
     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.ref_name"
     required: false
   draft:
     description: "Creates a draft release. Defaults to false"
@@ -21,9 +21,19 @@ inputs:
   prerelease:
     description: "Identify the release as a prerelease. Defaults to false"
     required: false
+  preserve_order:
+    description: "Preserver the order of the artifacts when uploading"
+    required: false
   files:
     description: "Newline-delimited list of path globs for asset files to upload"
     required: false
+  working_directory:
+    description: "Base directory to resolve 'files' globs against (defaults to job working-directory)"
+    required: false
+  overwrite_files:
+    description: "Overwrite existing files with the same name. Defaults to true"
+    required: false
+    default: 'true'
   fail_on_unmatched_files:
     description: "Fails if any of the `files` globs match nothing. Defaults to false"
     required: false
@@ -40,8 +50,17 @@ 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"
+  GITHUB_TOKEN: "As provided by Github Actions"
 outputs:
   url:
     description: "URL to the Release HTML Page"
@@ -49,8 +68,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"

jest.config.js

@@ -1,11 +0,0 @@
-module.exports = {
-  clearMocks: true,
-  moduleFileExtensions: ['js', 'ts'],
-  testEnvironment: 'node',
-  testMatch: ['**/*.test.ts'],
-  testRunner: 'jest-circus/runner',
-  transform: {
-    '^.+\\.ts$': 'ts-jest'
-  },
-  verbose: true
-}

package.json

@@ -1,45 +1,44 @@
 {
   "name": "action-gh-release",
-  "version": "0.1.11",
+  "version": "2.4.0",
   "private": true,
   "description": "GitHub Action for creating GitHub Releases",
   "main": "lib/main.js",
   "scripts": {
-    "build": "ncc build src/main.ts --minify",
+    "build": "ncc build src/main.ts --minify --target es2022",
-    "test": "jest",
+    "build-debug": "ncc build src/main.ts --v8-cache --source-map",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest --coverage",
     "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/core": "^1.11.1",
-    "@actions/github": "^5.0.0",
+    "@actions/github": "^6.0.1",
-    "@octokit/plugin-retry": "^3.0.9",
+    "@octokit/plugin-retry": "^8.0.2",
-    "@octokit/plugin-throttling": "^3.5.1",
+    "@octokit/plugin-throttling": "^11.0.2",
-    "glob": "^7.1.6",
+    "glob": "^11.0.3",
-    "mime": "^2.4.4",
+    "mime-types": "^3.0.1"
-    "node-fetch": "^2.6.1"
   },
   "devDependencies": {
-    "@types/glob": "^7.1.1",
+    "@types/glob": "^9.0.0",
-    "@types/jest": "^24.0.25",
+    "@types/mime-types": "^3.0.1",
-    "@types/mime": "^2.0.1",
+    "@types/node": "^20.19.19",
-    "@types/node": "^12.12.24",
+    "@vercel/ncc": "^0.38.4",
-    "@types/node-fetch": "^2.5.12",
+    "@vitest/coverage-v8": "^3.2.4",
-    "@zeit/ncc": "^0.21.0",
+    "prettier": "3.6.2",
-    "jest": "^24.9.0",
+    "ts-node": "^10.9.2",
-    "jest-circus": "^24.9.0",
+    "typescript": "^5.9.3",
-    "prettier": "1.19.1",
+    "typescript-formatter": "^7.2.2",
-    "ts-jest": "^24.2.0",
+    "vitest": "^3.1.4"
-    "typescript": "^3.7.4",
-    "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,9 +1,9 @@
-import fetch from "node-fetch";
+import { GitHub } from '@actions/github/lib/utils';
-import { GitHub } from "@actions/github/lib/utils";
+import { statSync } from 'fs';
-import { Config, isTag, releaseBody } from "./util";
+import { open } from 'fs/promises';
-import { lstatSync, readFileSync } from "fs";
+import { lookup } from 'mime-types';
-import { getType } from "mime";
+import { basename } from 'path';
-import { basename } from "path";
+import { alignAssetName, Config, isTag, releaseBody } from './util';
 
 type GitHub = InstanceType<typeof GitHub>;
 
@@ -11,7 +11,6 @@ export interface ReleaseAsset {
   name: string;
   mime: string;
   size: number;
-  data: Buffer;
 }
 
 export interface Release {
@@ -28,11 +27,7 @@ export interface Release {
 }
 
 export interface Releaser {
-  getReleaseByTag(params: {
+  getReleaseByTag(params: { owner: string; repo: string; tag: string }): Promise<{ data: Release }>;
-    owner: string;
-    repo: string;
-    tag: string;
-  }): Promise<{ data: Release }>;
 
   createRelease(params: {
     owner: string;
@@ -44,6 +39,8 @@ export interface Releaser {
     prerelease: boolean | undefined;
     target_commitish: string | undefined;
     discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
+    make_latest: 'true' | 'false' | 'legacy' | undefined;
   }): Promise<{ data: Release }>;
 
   updateRelease(params: {
@@ -57,12 +54,11 @@ export interface Releaser {
     draft: boolean | undefined;
     prerelease: boolean | undefined;
     discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
+    make_latest: 'true' | 'false' | 'legacy' | undefined;
   }): Promise<{ data: Release }>;
 
-  allReleases(params: {
+  allReleases(params: { owner: string; repo: string }): AsyncIterableIterator<{ data: Release[] }>;
-    owner: string;
-    repo: string;
-  }): AsyncIterableIterator<{ data: Release[] }>;
 }
 
 export class GitHubReleaser implements Releaser {
@@ -89,7 +85,16 @@ export class GitHubReleaser implements Releaser {
     prerelease: boolean | undefined;
     target_commitish: string | undefined;
     discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
+    make_latest: 'true' | 'false' | 'legacy' | undefined;
   }): Promise<{ data: Release }> {
+    if (
+      typeof params.make_latest === 'string' &&
+      !['true', 'false', 'legacy'].includes(params.make_latest)
+    ) {
+      params.make_latest = undefined;
+    }
+
     return this.github.rest.repos.createRelease(params);
   }
 
@@ -104,17 +109,23 @@ export class GitHubReleaser implements Releaser {
     draft: boolean | undefined;
     prerelease: boolean | undefined;
     discussion_category_name: string | undefined;
+    generate_release_notes: boolean | undefined;
+    make_latest: 'true' | 'false' | 'legacy' | undefined;
   }): Promise<{ data: Release }> {
+    if (
+      typeof params.make_latest === 'string' &&
+      !['true', 'false', 'legacy'].includes(params.make_latest)
+    ) {
+      params.make_latest = undefined;
+    }
+
     return this.github.rest.repos.updateRelease(params);
   }
 
-  allReleases(params: {
+  allReleases(params: { owner: string; repo: string }): AsyncIterableIterator<{ data: Release[] }> {
-    owner: string;
-    repo: string;
-  }): AsyncIterableIterator<{ data: Release[] }> {
     const updatedParams = { per_page: 100, ...params };
     return this.github.paginate.iterator(
-      this.github.rest.repos.listReleases.endpoint.merge(updatedParams)
+      this.github.rest.repos.listReleases.endpoint.merge(updatedParams),
     );
   }
 }
@@ -123,13 +134,12 @@ export const asset = (path: string): ReleaseAsset => {
   return {
     name: basename(path),
     mime: mimeOrDefault(path),
-    size: lstatSync(path).size,
+    size: statSync(path).size,
-    data: readFileSync(path),
   };
 };
 
 export const mimeOrDefault = (path: string): string => {
-  return getType(path) || "application/octet-stream";
+  return lookup(path) || 'application/octet-stream';
 };
 
 export const upload = async (
@@ -137,131 +147,130 @@ export const upload = async (
   github: GitHub,
   url: string,
   path: string,
-  currentAssets: Array<{ id: number; name: string }>
+  currentAssets: Array<{ id: number; name: string }>,
 ): Promise<any> => {
-  const [owner, repo] = config.github_repository.split("/");
+  const [owner, repo] = config.github_repository.split('/');
-  const { name, size, mime, data: body } = asset(path);
+  const { name, mime, size } = asset(path);
   const currentAsset = currentAssets.find(
-    ({ name: currentName }) => currentName == name
+    // note: GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "List release assets" endpoint lists the renamed filenames.
+    // due to this renaming we need to be mindful when we compare the file name we're uploading with a name github may already have rewritten for logical comparison
+    // see https://docs.github.com/en/rest/releases/assets?apiVersion=2022-11-28#upload-a-release-asset
+    ({ name: currentName }) => currentName == alignAssetName(name),
   );
   if (currentAsset) {
-    console.log(`♻️ Deleting previously uploaded asset ${name}...`);
+    if (config.input_overwrite_files === false) {
-    await github.rest.repos.deleteReleaseAsset({
+      console.log(`Asset ${name} already exists and overwrite_files is false...`);
-      asset_id: currentAsset.id || 1,
+      return null;
-      owner,
+    } else {
-      repo,
+      console.log(`♻️ Deleting previously uploaded asset ${name}...`);
-    });
+      await github.rest.repos.deleteReleaseAsset({
+        asset_id: currentAsset.id || 1,
+        owner,
+        repo,
+      });
+    }
   }
   console.log(`⬆️ Uploading ${name}...`);
   const endpoint = new URL(url);
-  endpoint.searchParams.append("name", name);
+  endpoint.searchParams.append('name', name);
-  const resp = await fetch(endpoint, {
+  const fh = await open(path);
-    headers: {
+  try {
-      "content-length": `${size}`,
+    const resp = await github.request({
-      "content-type": mime,
+      method: 'POST',
-      authorization: `token ${config.github_token}`,
+      url: endpoint.toString(),
-    },
+      headers: {
-    method: "POST",
+        'content-length': `${size}`,
-    body,
+        'content-type': mime,
-  });
+        authorization: `token ${config.github_token}`,
-  const json = await resp.json();
+      },
-  if (resp.status !== 201) {
+      data: fh.readableWebStream({ type: 'bytes' }),
-    throw new Error(
+    });
-      `Failed to upload release asset ${name}. recieved status code ${
+    const json = resp.data;
-        resp.status
+    if (resp.status !== 201) {
-      }\n${json.message}\n${JSON.stringify(json.errors)}`
+      throw new Error(
-    );
+        `Failed to upload release asset ${name}. received status code ${
+          resp.status
+        }\n${json.message}\n${JSON.stringify(json.errors)}`,
+      );
+    }
+    console.log(`✅ Uploaded ${name}`);
+    return json;
+  } finally {
+    await fh.close();
   }
-  return json;
 };
 
 export const release = async (
   config: Config,
   releaser: Releaser,
-  maxRetries: number = 3
+  maxRetries: number = 3,
 ): Promise<Release> => {
   if (maxRetries <= 0) {
     console.log(`❌ Too many retries. Aborting...`);
-    throw new Error("Too many retries.");
+    throw new Error('Too many retries.');
   }
 
-  const [owner, repo] = config.github_repository.split("/");
+  const [owner, repo] = config.github_repository.split('/');
   const tag =
     config.input_tag_name ||
-    (isTag(config.github_ref)
+    (isTag(config.github_ref) ? config.github_ref.replace('refs/tags/', '') : '');
-      ? 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
+    const _release: Release | undefined = await findTagFromReleases(releaser, owner, repo, tag);
-    // so we must find one in the list of all releases
+
-    if (config.input_draft) {
+    if (_release === undefined) {
-      for await (const response of releaser.allReleases({
+      return await createRelease(
+        tag,
+        config,
+        releaser,
         owner,
         repo,
-      })) {
+        discussion_category_name,
-        let release = response.data.find((release) => release.tag_name === tag);
+        generate_release_notes,
-        if (release) {
+        maxRetries,
-          return release;
+      );
-        }
-      }
     }
-    console.log(`fetching existing release for tag ${owner}/${repo}/${tag}`);
-    let existingRelease = await releaser.getReleaseByTag({
-      owner,
-      repo,
-      tag,
-    });
-    console.log(`found release ${existingRelease.data.id}`);
 
-    const release_id = existingRelease.data.id;
+    let existingRelease: Release = _release!;
+    console.log(`Found release ${existingRelease.name} (with id=${existingRelease.id})`);
+
+    const release_id = existingRelease.id;
     let target_commitish: string;
     if (
       config.input_target_commitish &&
-      config.input_target_commitish !== existingRelease.data.target_commitish
+      config.input_target_commitish !== existingRelease.target_commitish
     ) {
       console.log(
-        `Updating commit from "${existingRelease.data.target_commitish}" to "${config.input_target_commitish}"`
+        `Updating commit from "${existingRelease.target_commitish}" to "${config.input_target_commitish}"`,
       );
       target_commitish = config.input_target_commitish;
     } else {
-      target_commitish = existingRelease.data.target_commitish;
+      target_commitish = existingRelease.target_commitish;
     }
 
     const tag_name = tag;
-    const name = config.input_name || existingRelease.data.name || tag;
+    const name = config.input_name || existingRelease.name || tag;
+    // 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.body || '';
+    let body: string;
+    if (config.input_append_body && workflowBody && existingReleaseBody) {
+      body = existingReleaseBody + '\n' + workflowBody;
+    } else {
+      body = workflowBody || existingReleaseBody;
+    }
 
-    let body: string = "";
+    const draft = config.input_draft !== undefined ? config.input_draft : existingRelease.draft;
-    if (existingRelease.data.body) body += existingRelease.data.body;
-    let workflowBody = releaseBody(config);
-    if (existingRelease.data.body && workflowBody) body += "\n";
-    if (workflowBody) body += workflowBody;
-
-    const draft =
-      config.input_draft !== undefined
-        ? config.input_draft
-        : existingRelease.data.draft;
     const prerelease =
-      config.input_prerelease !== undefined
+      config.input_prerelease !== undefined ? config.input_prerelease : existingRelease.prerelease;
-        ? config.input_prerelease
+
-        : existingRelease.data.prerelease;
+    const make_latest = config.input_make_latest;
 
-    console.log(
-      `attemping update of release_id ${release_id} tag_name ${tag_name} target_commitish ${target_commitish} discussion_category_name ${discussion_category_name}`
-    );
-    console.log({
-      owner,
-      repo,
-      release_id,
-      tag_name,
-      target_commitish,
-      name,
-      body,
-      draft,
-      prerelease,
-      discussion_category_name,
-    });
     const release = await releaser.updateRelease({
       owner,
       repo,
@@ -273,67 +282,127 @@ export const release = async (
       draft,
       prerelease,
       discussion_category_name,
+      generate_release_notes,
+      make_latest,
     });
-    console.log(`updated release ${release_id}`);
     return release.data;
   } catch (error) {
-    if (error.status === 404) {
+    if (error.status !== 404) {
-      console.log(`update failed with 404`);
-      console.log(JSON.stringify(error.response.data.errors));
-      const tag_name = tag;
-      const name = config.input_name || tag;
-      const body = releaseBody(config);
-      const draft = config.input_draft;
-      const prerelease = config.input_prerelease;
-      const target_commitish = config.input_target_commitish;
-      let commitMessage: string = "";
-      if (target_commitish) {
-        commitMessage = ` using commit "${target_commitish}"`;
-      }
       console.log(
-        `👩‍🏭 Creating new GitHub release for tag ${tag_name}${commitMessage}...`
+        `⚠️ Unexpected error fetching GitHub release for tag ${config.github_ref}: ${error}`,
-      );
-
-      console.log({
-        owner,
-        repo,
-        tag_name,
-        name,
-        body,
-        draft,
-        prerelease,
-        target_commitish,
-        discussion_category_name,
-      });
-      try {
-        let release = await releaser.createRelease({
-          owner,
-          repo,
-          tag_name,
-          name,
-          body,
-          draft,
-          prerelease,
-          target_commitish,
-          discussion_category_name,
-        });
-        return release.data;
-      } catch (error) {
-        // presume a race with competing metrix runs
-        console.log(
-          `⚠️ GitHub release failed with status: ${
-            error.status
-          }\n${JSON.stringify(
-            error.response.data.errors
-          )}\nretrying... (${maxRetries - 1} retries remaining)`
-        );
-        return release(config, releaser, maxRetries - 1);
-      }
-    } else {
-      console.log(
-        `⚠️ Unexpected error fetching GitHub release for tag ${config.github_ref}: ${error}`
       );
       throw error;
     }
+
+    return await createRelease(
+      tag,
+      config,
+      releaser,
+      owner,
+      repo,
+      discussion_category_name,
+      generate_release_notes,
+      maxRetries,
+    );
   }
 };
+
+/**
+ * Finds a release by tag name from all a repository's releases.
+ *
+ * @param releaser - The GitHub API wrapper for release operations
+ * @param owner - The owner of the repository
+ * @param repo - The name of the repository
+ * @param tag - The tag name to search for
+ * @returns The release with the given tag name, or undefined if no release with that tag name is found
+ */
+export async function findTagFromReleases(
+  releaser: Releaser,
+  owner: string,
+  repo: string,
+  tag: string,
+): Promise<Release | undefined> {
+  for await (const { data: releases } of releaser.allReleases({
+    owner,
+    repo,
+  })) {
+    const release = releases.find((release) => release.tag_name === tag);
+    if (release) {
+      return release;
+    }
+  }
+  return undefined;
+}
+
+async function createRelease(
+  tag: string,
+  config: Config,
+  releaser: Releaser,
+  owner: string,
+  repo: string,
+  discussion_category_name: string | undefined,
+  generate_release_notes: boolean | undefined,
+  maxRetries: number,
+) {
+  const tag_name = tag;
+  const name = config.input_name || tag;
+  const body = releaseBody(config);
+  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}"`;
+  }
+  console.log(`👩‍🏭 Creating new GitHub release for tag ${tag_name}${commitMessage}...`);
+  try {
+    let release = await releaser.createRelease({
+      owner,
+      repo,
+      tag_name,
+      name,
+      body,
+      draft,
+      prerelease,
+      target_commitish,
+      discussion_category_name,
+      generate_release_notes,
+      make_latest,
+    });
+    return release.data;
+  } catch (error) {
+    // presume a race with competing matrix runs
+    console.log(`⚠️ GitHub release failed with status: ${error.status}`);
+    console.log(`${JSON.stringify(error.response.data)}`);
+
+    switch (error.status) {
+      case 403:
+        console.log(
+          'Skip retry — your GitHub token/PAT does not have the required permission to create a release',
+        );
+        throw error;
+
+      case 404:
+        console.log('Skip retry - discussion category mismatch');
+        throw error;
+
+      case 422:
+        // Check if this is a race condition with "already_exists" error
+        const errorData = error.response?.data;
+        if (errorData?.errors?.[0]?.code === 'already_exists') {
+          console.log(
+            '⚠️ Release already exists (race condition detected), retrying to find and update existing release...',
+          );
+          // Don't throw - allow retry to find existing release
+        } else {
+          console.log('Skip retry - validation failed');
+          throw error;
+        }
+        break;
+    }
+
+    console.log(`retrying... (${maxRetries - 1} retries remaining)`);
+    return release(config, releaser, maxRetries - 1);
+  }
+}

src/main.ts

@@ -1,32 +1,25 @@
-import {
+import { setFailed, setOutput } from '@actions/core';
-  paths,
+import { getOctokit } from '@actions/github';
-  parseConfig,
+import { GitHubReleaser, release, upload } from './github';
-  isTag,
+import { isTag, parseConfig, paths, unmatchedPatterns, uploadUrl } from './util';
-  unmatchedPatterns,
-  uploadUrl
-} from "./util";
-import { release, upload, GitHubReleaser } from "./github";
-import { getOctokit } from "@actions/github";
-import { setFailed, setOutput } from "@actions/core";
-import { GitHub, getOctokitOptions } from "@actions/github/lib/utils";
 
-import { env } from "process";
+import { env } from 'process';
 
 async function run() {
   try {
     const config = parseConfig(env);
-    if (
+    if (!config.input_tag_name && !isTag(config.github_ref) && !config.input_draft) {
-      !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);
+      const patterns = unmatchedPatterns(config.input_files, config.input_working_directory);
-      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`);
       }
@@ -41,9 +34,7 @@ async function run() {
       //new oktokit(
       throttle: {
         onRateLimit: (retryAfter, options) => {
-          console.warn(
+          console.warn(`Request quota exhausted for request ${options.method} ${options.url}`);
-            `Request quota exhausted for request ${options.method} ${options.url}`
-          );
           if (options.request.retryCount === 0) {
             // only retries once
             console.log(`Retrying after ${retryAfter} seconds!`);
@@ -52,38 +43,48 @@ async function run() {
         },
         onAbuseLimit: (retryAfter, options) => {
           // does not retry, only logs a warning
-          console.warn(
+          console.warn(`Abuse detected for request ${options.method} ${options.url}`);
-            `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);
+      const files = paths(config.input_files, config.input_working_directory);
       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} does not include a valid file.`);
+        } else {
+          console.warn(`🤔 ${config.input_files} does not include a valid file.`);
+        }
       }
-      const currentAsserts = rel.assets;
+      const currentAssets = rel.assets;
-      await Promise.all(
+
-        files.map(async path => {
+      const uploadFile = async (path) => {
-          await upload(
+        const json = await upload(config, gh, uploadUrl(rel.upload_url), path, currentAssets);
-            config,
+        if (json) {
-            gh,
+          delete json.uploader;
-            uploadUrl(rel.upload_url),
+        }
-            path,
+        return json;
-            currentAsserts
+      };
-          );
+
-        })
+      let results: (any | null)[];
-      ).catch(error => {
+      if (!config.input_preserve_order) {
-        throw error;
+        results = await Promise.all(files.map(uploadFile));
-      });
+      } else {
+        results = [];
+        for (const path of files) {
+          results.push(await uploadFile(path));
+        }
+      }
+
+      const assets = results.filter(Boolean);
+      setOutput('assets', assets);
     }
     console.log(`🎉 Release ready at ${rel.html_url}`);
-    setOutput("url", rel.html_url);
+    setOutput('url', rel.html_url);
-    setOutput("id", rel.id.toString());
+    setOutput('id', rel.id.toString());
-    setOutput("upload_url", rel.upload_url);
+    setOutput('upload_url', rel.upload_url);
   } catch (error) {
     setFailed(error.message);
   }

src/util.ts

@@ -1,5 +1,6 @@
-import * as glob from "glob";
+import * as glob from 'glob';
-import { lstatSync, readFileSync } from "fs";
+import { statSync, readFileSync } from 'fs';
+import * as pathLib from 'path';
 
 export interface Config {
   github_token: string;
@@ -12,15 +13,21 @@ export interface Config {
   input_body?: string;
   input_body_path?: string;
   input_files?: string[];
+  input_working_directory?: string;
+  input_overwrite_files?: boolean;
   input_draft?: boolean;
+  input_preserve_order?: boolean;
   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: 'true' | 'false' | 'legacy' | undefined;
 }
 
 export const uploadUrl = (url: string): string => {
-  const templateMarkerPos = url.indexOf("{");
+  const templateMarkerPos = url.indexOf('{');
   if (templateMarkerPos > -1) {
     return url.substring(0, templateMarkerPos);
   }
@@ -29,8 +36,7 @@ export const uploadUrl = (url: string): string => {
 
 export const releaseBody = (config: Config): string | undefined => {
   return (
-    (config.input_body_path &&
+    (config.input_body_path && readFileSync(config.input_body_path).toString('utf8')) ||
-      readFileSync(config.input_body_path).toString("utf8")) ||
     config.input_body
   );
 };
@@ -41,52 +47,81 @@ export const parseInputFiles = (files: string): string[] => {
   return files.split(/\r?\n/).reduce<string[]>(
     (acc, line) =>
       acc
-        .concat(line.split(","))
+        .concat(line.split(','))
         .filter((pat) => pat)
         .map((pat) => pat.trim()),
-    []
+    [],
   );
 };
 
 export const parseConfig = (env: Env): Config => {
   return {
-    github_token: env.GITHUB_TOKEN || env.INPUT_TOKEN || "",
+    github_token: env.GITHUB_TOKEN || env.INPUT_TOKEN || '',
-    github_ref: env.GITHUB_REF || "",
+    github_ref: env.GITHUB_REF || '',
-    github_repository: env.INPUT_REPOSITORY || env.GITHUB_REPOSITORY || "",
+    github_repository: env.INPUT_REPOSITORY || env.GITHUB_REPOSITORY || '',
     input_name: env.INPUT_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 || ""),
+    input_files: parseInputFiles(env.INPUT_FILES || ''),
-    input_draft: env.INPUT_DRAFT ? env.INPUT_DRAFT === "true" : undefined,
+    input_working_directory: env.INPUT_WORKING_DIRECTORY || undefined,
-    input_prerelease: env.INPUT_PRERELEASE
+    input_overwrite_files: env.INPUT_OVERWRITE_FILES
-      ? env.INPUT_PRERELEASE == "true"
+      ? env.INPUT_OVERWRITE_FILES == 'true'
       : undefined,
-    input_fail_on_unmatched_files: env.INPUT_FAIL_ON_UNMATCHED_FILES == "true",
+    input_draft: env.INPUT_DRAFT ? env.INPUT_DRAFT === 'true' : undefined,
+    input_preserve_order: env.INPUT_PRESERVE_ORDER ? env.INPUT_PRESERVE_ORDER == 'true' : undefined,
+    input_prerelease: env.INPUT_PRERELEASE ? env.INPUT_PRERELEASE == 'true' : undefined,
+    input_fail_on_unmatched_files: env.INPUT_FAIL_ON_UNMATCHED_FILES == 'true',
     input_target_commitish: env.INPUT_TARGET_COMMITISH || undefined,
-    input_discussion_category_name:
+    input_discussion_category_name: env.INPUT_DISCUSSION_CATEGORY_NAME || undefined,
-      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: parseMakeLatest(env.INPUT_MAKE_LATEST),
   };
 };
 
-export const paths = (patterns: string[]): string[] => {
+const parseMakeLatest = (value: string | undefined): 'true' | 'false' | 'legacy' | undefined => {
+  if (value === 'true' || value === 'false' || value === 'legacy') {
+    return value;
+  }
+  return undefined;
+};
+
+export const paths = (patterns: string[], cwd?: string): string[] => {
   return patterns.reduce((acc: string[], pattern: string): string[] => {
-    return acc.concat(
+    const matches = glob.sync(pattern, { cwd, dot: true, absolute: false });
-      glob.sync(pattern).filter((path) => lstatSync(path).isFile())
+    const resolved = matches
-    );
+      .map((p) => (cwd ? pathLib.join(cwd, p) : p))
+      .filter((p) => {
+        try {
+          return statSync(p).isFile();
+        } catch {
+          return false;
+        }
+      });
+    return acc.concat(resolved);
   }, []);
 };
 
-export const unmatchedPatterns = (patterns: string[]): string[] => {
+export const unmatchedPatterns = (patterns: string[], cwd?: string): string[] => {
   return patterns.reduce((acc: string[], pattern: string): string[] => {
-    return acc.concat(
+    const matches = glob.sync(pattern, { cwd, dot: true, absolute: false });
-      glob.sync(pattern).filter((path) => lstatSync(path).isFile()).length == 0
+    const files = matches.filter((p) => {
-        ? [pattern]
+      try {
-        : []
+        const full = cwd ? pathLib.join(cwd, p) : p;
-    );
+        return statSync(full).isFile();
+      } catch {
+        return false;
+      }
+    });
+    return acc.concat(files.length == 0 ? [pattern] : []);
   }, []);
 };
 
 export const isTag = (ref: string): boolean => {
-  return ref.startsWith("refs/tags/");
+  return ref.startsWith('refs/tags/');
+};
+
+export const alignAssetName = (assetName: string): string => {
+  return assetName.replace(/ /g, '.');
 };

tsconfig.json

@@ -1,9 +1,10 @@
 {
   "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'. */
+    "target": "es2022",
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "module": "NodeNext",
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
@@ -24,6 +25,7 @@
     /* Strict Type-Checking Options */
     "strict": true,                           /* Enable all strict type-checking options. */
     "noImplicitAny": false,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    "skipLibCheck": true,
     // "strictNullChecks": true,              /* Enable strict null checks. */
     // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
     // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
@@ -43,7 +45,7 @@
     // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
+    "types": ["vitest/globals"],
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
     "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
@@ -59,5 +61,5 @@
     // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
     // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
   },
-  "exclude": ["node_modules", "**/*.test.ts"]
+  "exclude": ["node_modules", "**/*.test.ts", "vitest.config.ts"]
-}
+}

vitest.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    environment: 'node',
+    coverage: {
+      reporter: ['text', 'lcov'],
+    },
+    include: ['__tests__/**/*.ts'],
+  },
+});