Skip to content

Changelog #9

Description

@ghostdevv

I've implemented changelog before and what I landed on was (assuming we want to render the changelog, not just link to it)

  1. Check the tarball for the CHANGELOG.md file
  2. Check the repo for the CHANGELOG.md file
  3. Pull from GitHub releases

I'm also looking to re-implement this on the work in progress api, but with better checks for the changelog file since we can process the whole tarball like yarn/algolia does here (although there are even more options I can think of).

con: if adopted by npm they could bring breaking changes like with what css nesting did in sass/scss.

The entire registry is full of inconsistencies so I think we'd be ok!

Have an "npmx" object field and then in there have "changelogs" field (example: {"npmx": {"changelogs": "https://example.pkg/changes"}})

If we could do it without this that'd be cool, especially if it encourages more people to ship a changelog file with their package

Originally posted by @ghostdevv in #501

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions