Skip to content

Latest commit

 

History

History
455 lines (299 loc) · 15.5 KB

CHANGELOG.md

File metadata and controls

455 lines (299 loc) · 15.5 KB
Raw

Changelog

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

v5.4.0 - 2024-08-27

Added

Config file schema support

The configuration schema is now published at: https://ghalactic.github.io/github-release-from-tag/schema/config.v5.schema.json

Your editor might be able to use this schema to provide autocompletion and validation for your configuration file. For example, if you're using the YAML extension for Visual Studio Code, you can add the following header to your configuration file to enable schema support:

# yaml-language-server: $schema=https://ghalactic.github.io/github-release-from-tag/schema/config.v5.schema.json
assets:
  - path: assets/text/file-a.txt
  - path: assets/json/file-b.json
    optional: true
    name: custom-name-b.json
    label: Label for file-b.json

In case your editor supports using a $schema property directly in the YAML file, the schema has been relaxed to allow this as well:

$schema: https://ghalactic.github.io/github-release-from-tag/schema/config.v5.schema.json
assets:
  - path: assets/text/file-a.txt
  - path: assets/json/file-b.json
    optional: true
    name: custom-name-b.json
    label: Label for file-b.json

Fixed

  • Fixed parsing of empty configuration files with comments.

v5.3.0 - 2024-08-24

Added

Markdown heading anchors

Anchors are now added to headings in the release body. This makes it possible to link directly to a specific section of the release body, either from within the release body itself, or externally once the release is created. You would probably expect GitHub to do this as a part of its release body rendering, just like it does for READMEs, but surprisingly it doesn't. So, now this action will do it for you.

v5.2.1 - 2024-06-09

Fixed

  • Dependency updates.

v5.2.0 - 2024-03-09

Added

  • This action now uploads checksum assets when a release has assets associated with it. Checksum assets are files that contain the checksums of the other release assets. This feature is enabled by default, but can be disabled via configuration.
  • Asset checksums are now available in the assets output. These checksums are always available, even if the checksum assets feature is disabled.

v5.1.1 - 2024-03-07

Fixed

v5.1.0 - 2024-03-07

Added

Tip

This means you can add alerts like this one to your tag annotation bodies, and they will appear in the published release. To add an alert, use the following syntax:

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

v5.0.1 - 2024-03-06

Fixed

  • Dependency updates.

v5.0.0 - 2023-08-28

Changed

  • This action now runs on the node20 runner instead of node16. If you are using this action on GitHub Enterprise Server, you will need to ensure your runners support node20 before upgrading to this version.

v4.2.0 - 2023-08-28

Changed

  • Reverted the v4 version of this action to run on Node.js 16.x instead of 20.x. The switch to 20.x was causing issues with GitHub Enterprise Server users who don't have support for node20 runners yet. A v5 version of this action will be released shortly that will run on Node.js 20.x.

v4.1.3 - 2023-08-26

Fixed

  • Fixed further internal issues with GitHub Actions shared workflows. No effect on the action itself.

v4.1.2 - 2023-08-26

Fixed

  • Fixed further internal issues with GitHub Actions shared workflows. No effect on the action itself.

v4.1.1 - 2023-08-26

Fixed

  • Fixed internal GitHub Actions shared workflow permissions issues. No effect on the action itself.

v4.1.0 - 2023-08-26

Changed

  • This action now runs on Node.js 20.x instead of 16.x.

v4.0.1 - 2023-05-21

Fixed

  • Updated examples in the README to reference v4.

v4.0.0 - 2023-05-21

This action has been migrated to a new organization named Ghalactic that is dedicated to housing high-quality GitHub actions. Please update your workflows to reference the action's new location at ghalactic/github-release-from-tag@v4.

Migrating from v3 to v4

  • Update the uses value from eloquent/github-release-action@v3 to ghalactic/github-release-from-tag@v4.
  • Rename any configuration files from .github/release.eloquent.yml to .github/github-release-from-tag.yml.

Backwards-compatibility breaks

  • Configuration files must now be located at .github/github-release-from-tag.yml.

Changed

  • The repo was moved to ghalactic/github-release-from-tag.

v3.2.1 - 2023-05-14

Other

  • Converted to TypeScript.

v3.2.0 - 2023-04-06

Improved

  • Switched from Docker to Node.js runtime for faster startup times.
  • Added @octokit/plugin-retry to improve resilience against transient network issues.

v3.1.4 - 2023-02-06

Fixed

  • Fixed Git "dubious ownership" error that occurs due to the way GitHub Actions sets up ownership of the workspace directory. This action now explicitly adds the workspace directory to Git's list of "safe" directories to avoid the error.

v3.1.3 - 2023-01-17

Fixed

  • Fixed rendering of workflow summaries.

v3.1.2 - 2022-11-21

Fixed

v3.1.1 - 2022-09-13

Changed

  • The attribution comment will now be appended to the end of the release body instead of the beginning. This is a precaution, in case having the comment at the beginning of the body might cause Dependabot to truncate more of the actual release notes.

v3.1.0 - 2022-09-11

Added

  • Actions job summaries will now include information about the user that created the tag.
  • Added the summaryEnabled input, which can be used to disable job summary creation.
  • Added the summary.enabled config option, which can be used to disable job summary creation.
  • Added the taggerAvatarUrl output, which contains the avatar URL of the GitHub user who created the tag.
  • Added the taggerLogin output, which contains the username of the GitHub user who created the tag.

Changed

  • Removed remark-github from the Markdown processor. It was causing user mentions and other references to render without hover cards in release bodies. It was also likely to cause more trouble when integrating with GitHub Enterprise Server.

v3.0.0 - 2022-09-10

Added

  • Actions job summaries will now be created when the action is successful.

Removed

  • Workflow annotations containing the release URL will no longer be created when the action is successful. This feature has been replaced by job summaries.

Changed

  • [BC BREAK] Release bodies will no longer be rendered as HTML, and instead will undergo Markdown parsing and transformation to address the handling of Markdown line breaks.
    • This is primarily to address #36 and #37.
    • Most Markdown / GFM features are now handled by Remark (with remark-gfm and remark-github) instead of GitHub's own Markdown API.
    • There could be lots of subtle changes to the way release bodies are rendered. In practice, you will probably not even notice the difference (I hope).
  • [BC BREAK] The tagBodyRendered output will no longer contain HTML, but instead will contain a transformed version of the Markdown from the tag annotation body.

Fixed

  • Dependabot should no longer render empty release notes inside of dependency update pull request descriptions for dependencies that use this action to manage their releases (#36).
  • Issue links in release bodies should no longer fail to render (#37).

v2.1.2 - 2022-09-01

Fixed

  • Fixed stripping of SSH signatures from tag annotation bodies (the previous fix did not actually work).

v2.1.1 - 2022-09-01

Fixed

  • Fixed stripping of SSH signatures from tag annotation bodies.
  • Fixed excessive newlines being printed because of an issue in @actions/toolkit.

v2.1.0 - 2022-08-03

Added

v2.0.0 - 2022-06-05

Changed

  • [BC BREAK] This action was completely re-written in v2 with support for many new features. With that being said, it should be pretty much 100% compatible with v1.
  • [BC BREAK] The GITHUB_TOKEN environment variable can no longer be used to supply a custom GitHub token. Use the token action input instead.
  • [BC BREAK] Improved the rendering of line breaks in tag annotation message bodies. See Markdown line breaks for more information.
  • [BC BREAK] Tag names like v1 and v1.2 are now considered "stable" as per GitHub's recommendations for action versioning.

Added