Skip to content

Notes in GitHub Releases #22489

@mfulton26

Description

@mfulton26

Documentation is

  • Missing
  • Outdated
  • Confusing
  • Not sure?

Explain in Detail

I follow releases via GitHub. This works great for Vite+, Vitest, Rolldown, and Oxc. They each include details on changes in the GitHub releases. For Vite though, the release notes link to the changelog. Some tools like Dependabot won't pick those up. I know it is only any extra click but for me too I wish the notes were in the release itself for easy reading along with all my other GitHub notifications.

Your Suggestion for Changes

Continue to maintain the changelog as is but also include the notes in individual releases in GitHub.

Reproduction

https://github.com/vitejs/vite/releases

Steps to reproduce

Open any release and see how instead of containing the notes directly it contains "Please refer to CHANGELOG.md for details."

This differs from other VoidZero open source repositories which do include their notes in the actual release:

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions