Skip to content

Latest commit

 

History

History
500 lines (307 loc) · 22.4 KB

CHANGELOG.md

File metadata and controls

500 lines (307 loc) · 22.4 KB

3.0.4

  • maintenance release with updated dependencies

3.0.3

3.0.3 is a maintenance release with updated dependencies. It also safely classifies malformed GitHub API errors to avoid secondary failures (#822).

What's Changed

Bug fixes 🐛

  • fix: safely classify GitHub API errors by @chenrui333 in #822

Other Changes 🔄

  • dependency updates

3.0.2

3.0.2 is a patch release focused on release reliability and compatibility. It reuses existing draft releases when publishing prereleases, supports replacing release assets on Gitea, hardens streamed asset uploads, and provides clearer release-creation diagnostics. It also includes TypeScript, coverage, and tooling maintenance merged since 3.0.1.

This release fixes #795, #438, and #803. The upload transport hardening covers the historical failure reported in #790, although current hosted Node 24 runners did not reproduce it naturally. The diagnostics work is related to #786 and does not claim a reproducible release-creation fix.

What's Changed

Exciting New Features 🎉

  • feat: improve release error reporting and test coverage by @chenrui333 in #813

Bug fixes 🐛

  • fix: publish existing draft releases as prereleases by @godfengliang in #801
  • fix: upload small checksum assets reliably by @chenrui333 in #815
  • fix: replace existing release assets on Gitea by @chenrui333 in #816
  • fix: clarify release creation 404 errors by @chenrui333 in #817

Other Changes 🔄

  • chore(deps): upgrade TypeScript to 7 by @chenrui333 in #812
  • chore(deps): remove unused TypeScript tooling by @chenrui333 in #814
  • dependency, Node 24 pin, and CI maintenance merged since 3.0.1

3.0.1

  • maintenance release with updated dependencies

3.0.0

3.0.0 is a major release that moves the action runtime from Node 20 to Node 24. Use v3 on GitHub-hosted runners and self-hosted fleets that already support the Node 24 Actions runtime. v2.6.2 was the final Node 20-compatible release and is no longer maintained or supported.

What's Changed

Other Changes 🔄

  • Move the action runtime and bundle target to Node 24
  • Update @types/node to the Node 24 line and allow future Dependabot updates
  • Keep the floating major tag on v3; freeze v2 at the final v2.6.2 release

2.6.2

2.6.2 is the final v2 release and is no longer maintained or supported. Upgrade to v3 for the supported Node 24 runtime and current fixes.

What's Changed

Other Changes 🔄

  • chore(deps): bump picomatch from 4.0.3 to 4.0.4 by @dependabot[bot] in #775
  • chore(deps): bump brace-expansion from 5.0.4 to 5.0.5 by @dependabot[bot] in #777
  • chore(deps): bump vite from 8.0.0 to 8.0.5 by @dependabot[bot] in #781

2.6.1

2.6.1 is a patch release focused on restoring linked discussion thread creation when discussion_category_name is set. It fixes #764, where the draft-first publish flow stopped carrying the discussion category through the final publish step.

If you still hit an issue after upgrading, please open a report with the bug template and include a minimal repro or sanitized workflow snippet where possible.

What's Changed

Bug fixes 🐛

  • fix: preserve discussion category on publish by @chenrui333 in #765

2.6.0

2.6.0 is a minor release centered on previous_tag support for generate_release_notes, which lets workflows pin GitHub's comparison base explicitly instead of relying on the default range. It also includes the recent concurrent asset upload recovery fix, a working_directory docs sync, a checked-bundle freshness guard for maintainers, and clearer immutable-prerelease guidance where GitHub platform behavior imposes constraints on how prerelease asset uploads can be published.

If you still hit an issue after upgrading, please open a report with the bug template and include a minimal repro or sanitized workflow snippet where possible.

What's Changed

Exciting New Features 🎉

  • feat: support previous_tag for generate_release_notes by @pocesar in #372

Bug fixes 🐛

  • fix: recover concurrent asset metadata 404s by @chenrui333 in #760

Other Changes 🔄

  • docs: clarify reused draft release behavior by @chenrui333 in #759
  • docs: clarify working_directory input by @chenrui333 in #761
  • ci: verify dist bundle freshness by @chenrui333 in #762
  • fix: clarify immutable prerelease uploads by @chenrui333 in #763

2.5.3

2.5.3 is a patch release focused on the remaining path-handling and release-selection bugs uncovered after 2.5.2. It fixes #639, #571, #280, #614, #311, #403, and #368. It also adds documentation clarifications for #541, #645, #542, #393, and #411, where the current behavior is either usage-sensitive or constrained by GitHub platform limits rather than an action-side runtime bug.

If you still hit an issue after upgrading, please open a report with the bug template and include a minimal repro or sanitized workflow snippet where possible.

What's Changed

Bug fixes 🐛

  • fix: prefer token input over GITHUB_TOKEN by @chenrui333 in #751
  • fix: clean up duplicate drafts after canonicalization by @chenrui333 in #753
  • fix: support Windows-style file globs by @chenrui333 in #754
  • fix: normalize refs-tag inputs by @chenrui333 in #755
  • fix: expand tilde file paths by @chenrui333 in #756

Other Changes 🔄

  • docs: clarify token precedence by @chenrui333 in #752
  • docs: clarify GitHub release limits by @chenrui333 in #758
  • documentation clarifications for empty-token handling, preserve_order, and special-character asset filename behavior

2.5.2

2.5.2 is a patch release focused on the remaining release-creation and prerelease regressions in the 2.5.x bug-fix cycle. It fixes #705, fixes #708, fixes #740, fixes #741, and fixes #722. Regression testing covers the shared-tag race, prerelease event behavior, dotfile asset labels, same-filename concurrent uploads, and blocked-tag cleanup behavior.

If you still hit an issue after upgrading, please open a report with the bug template and include a minimal repro or sanitized workflow snippet where possible.

What's Changed

Bug fixes 🐛

  • fix: canonicalize releases after concurrent create by @chenrui333 in #746
  • fix: preserve prereleased events for prereleases by @chenrui333 in #748
  • fix: restore dotfile asset labels by @chenrui333 in #749
  • fix: handle upload already_exists races across workflows by @api2062 in #745
  • fix: clean up orphan drafts when tag creation is blocked by @chenrui333 in #750

2.5.1

2.5.1 is a patch release focused on regressions introduced in 2.5.0 and on release lookup reliability. It fixes #713, addresses #703, and fixes #724. Regression testing shows that current master no longer reproduces the finalize-race behavior reported in #704 and #709.

What's Changed

Bug fixes 🐛

  • fix: fetch correct asset URL after finalization; test; some refactoring by @pzhlkj6612 in #738
  • fix: release marked as 'latest' despite make_latest: false by @Boshen in #715
  • fix: use getReleaseByTag API instead of iterating all releases by @kim-em in #725

Other Changes 🔄

  • dependency updates, including the ESM/runtime compatibility refresh in #731

2.5.0

What's Changed

Exciting New Features 🎉

  • feat: mark release as draft until all artifacts are uploaded by @dumbmoron in #692

Other Changes 🔄

  • dependency updates

2.4.2

What's Changed

Exciting New Features 🎉

  • feat: Ensure generated release notes cannot be over 125000 characters by @BeryJu in #684

Other Changes 🔄

  • dependency updates

2.4.1

What's Changed

Other Changes 🔄

  • fix(util): support brace expansion globs containing commas in parseInputFiles by @Copilot in #672
  • fix: gracefully fallback to body when body_path cannot be read by @Copilot in #671

2.4.0

What's Changed

Exciting New Features 🎉

  • feat(action): respect working_directory for files globs by @stephenway in #667

2.3.4

What's Changed

Bug fixes 🐛

  • fix(action): handle 422 already_exists race condition by @stephenway in #665

Other Changes 🔄

  • dependency updates

2.3.3

What's Changed

Exciting New Features 🎉

  • feat: add input option overwrite_files by @asfernandes in #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 #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 #316

Other Changes 🔄

  • chore: simplify ref_type test by @steinybot in #598
  • fix(docs): clarify the default for tag_name by @muzimuzhi in #599
  • test(release): add unit tests when searching for a release by @rwaskiewicz in #603
  • dependency updates

2.2.1

What's Changed

Bug fixes 🐛

  • fix: big file uploads by @xen0n in #562

Other Changes 🔄

  • chore(deps): bump @types/node from 22.10.1 to 22.10.2 by @dependabot in #559
  • chore(deps): bump @types/node from 22.10.2 to 22.10.5 by @dependabot in #569
  • chore: update error and warning messages for not matching files in files field by @ytimocin in #568

2.2.0

What's Changed

Exciting New Features 🎉

  • feat: read the release assets asynchronously by @xen0n in #552

Bug fixes 🐛

  • fix(docs): clarify the default for tag_name by @alexeagle in #544

Other Changes 🔄

  • chore(deps): bump typescript from 5.6.3 to 5.7.2 by @dependabot in #548
  • chore(deps): bump @types/node from 22.9.0 to 22.9.4 by @dependabot in #547
  • chore(deps): bump cross-spawn from 7.0.3 to 7.0.6 by @dependabot in #545
  • chore(deps): bump @vercel/ncc from 0.38.2 to 0.38.3 by @dependabot in #543
  • chore(deps): bump prettier from 3.3.3 to 3.4.1 by @dependabot in #550
  • chore(deps): bump @types/node from 22.9.4 to 22.10.1 by @dependabot in #551
  • chore(deps): bump prettier from 3.4.1 to 3.4.2 by @dependabot in #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 #518
  • feat: preserve upload order by @richarddd in #500

Other Changes 🔄

  • chore(deps): bump @types/node from 22.8.2 to 22.8.7 by @dependabot in #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 #480
  • chore(deps): bump @types/node from 20.14.9 to 20.14.11 by @dependabot in #483
  • chore(deps): bump @octokit/plugin-throttling from 9.3.0 to 9.3.1 by @dependabot in #484
  • chore(deps): bump glob from 10.4.2 to 11.0.0 by @dependabot in #477
  • refactor: write jest config in ts by @chenrui333 in #485
  • chore(deps): bump @actions/github from 5.1.1 to 6.0.0 by @dependabot in #470

2.0.7

Bug fixes 🐛

  • Fix missing update release body by @FirelightFlagboy in #365

Other Changes 🔄

  • Bump @octokit/plugin-retry from 4.0.3 to 7.1.1 by @dependabot in #443
  • Bump typescript from 4.9.5 to 5.5.2 by @dependabot in #467
  • Bump @types/node from 20.14.6 to 20.14.8 by @dependabot in #469
  • Bump @types/node from 20.14.8 to 20.14.9 by @dependabot in #473
  • Bump typescript from 5.5.2 to 5.5.3 by @dependabot in #472
  • Bump ts-jest from 29.1.5 to 29.2.2 by @dependabot in #479
  • docs: document that existing releases are updated by @jvanbruegge in #474

2.0.6

  • maintenance release with updated dependencies

2.0.5

  • Factor in file names with spaces when upserting files #446 via @MystiPanda
  • Improvements to error handling #449 via @till

2.0.4

2.0.3

  • Declare make_latest as an input field in action.yml #419

2.0.2

  • Revisit approach to #384 making unresolved pattern failures opt-in #417

2.0.1

2.0.0

  • 2.0.0!? this release corrects a disjunction between git tag versions used in the marketplace and the versions listed in 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 a new workflow input option generate_release_notes which when set to true will automatically generate release notes for you based on GitHub activity #179. Please see the GitHub docs for this feature for more information

0.1.13

  • fix issue with multiple runs concatenating release bodies #145

0.1.12

  • fix bug leading to empty strings substituted for inputs users don't provide breaking api calls #144

0.1.11

  • better error message on release create failed #143

0.1.10

  • fixed error message formatting for file uploads

0.1.9

  • add support for linking release to GitHub discussion #136

0.1.8

  • address recent warnings in assert upload api as well as introduce asset upload overrides, allowing for multiple runs for the same release with the same named asserts #134
  • fix backwards compatibility with GITHUB_TOKEN resolution. GITHUB_TOKEN is now resolved first from an env variable and then from an input #133
  • trim white space in provided tag_name #130

0.1.7

  • allow creating draft releases without a tag #95
  • Set default token for simpler setup #83
  • fix regression with action yml #126

0.1.6

This is a release catch up have a hiatus. Future releases will happen more frequently

  • Add 'fail_on_unmatched_files' input, useful for catching cases where your files input does not actually match what you expect #55
  • Add repository input, useful for creating a release in an external repository #61
  • Add release id to outputs, useful for referring to release in workflow steps following the step that uses this action #60
  • Add upload_url as action output, useful for managing uploads separately #75
  • Support custom target_commitish value, useful to customize the default #76
  • fix body_path input first then fall back on body input. This was the originally documented precedence but was implemented in the opposite order! #85
  • Retain original release info if the keys are not set, useful for filling in blanks for a release you've already started separately #109
  • Limit number of times github api request to create a release is retried, useful for avoiding eating up your rate limit and action minutes due to either an invalid token or other circumstance causing the api call to fail #111

0.1.5

  • Added support for specifying tag name #39

0.1.4

  • Added support for updating releases body #36
  • Steps can now access the url of releases with the url output of this Action #28
  • Added basic GitHub API retry support to manage API turbulence #26

0.1.3

  • Fixed where with: body_path was not being used in generated GitHub releases

0.1.2

  • Add support for merging draft releases #16

GitHub's api doesn't explicitly have a way of fetching a draft release by tag name which caused draft releases to appear as separate releases when used in a build matrix. This is now fixed.

  • Add support for newline-delimited asset list #18

GitHub actions inputs don't inherently support lists of things and one might like to append a list of files to include in a release. Previously this was possible using a comma-delimited list of asset path patterns to upload. You can now provide these as a newline delimited list for better readability

- name: Release
  uses: softprops/action-gh-release@v1
  if: startsWith(github.ref, 'refs/tags/')
  with:
    files: |
      filea.txt
      fileb.txt
      filec.txt
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  • Add support for prerelease annotated GitHub releases with the new input field with.prerelease: true #19

0.1.1

  • Add support for publishing releases on all supported virtual hosts

You'll need to remove docker:// prefix and use the @v1 action tag


0.1.0

  • Initial release