Skip to content

Allow extensions to expose changelog #5958

Description

@vekexasia

What do you want to change?

Add a way for extension developer to expose a changelog to be surfaced after pi is launched after pi update --extensions or pi update.

Why?

I think it might be helpful to have a standardized way to surface changelog for extensions. As of now pi already checks for extension updates but upon updating the user does not really know what has changed in the extensiosn that were updated

How? (optional)

Being that extensions are standard packages in npm we could use a custom package.json key like pi field that could be a structured object for future use. so now we can have

{
  "pi": {
    changelogPath: ...
  }
}

If that's not specified pi might want to check out if a file CHANGELOG.md , formatted like the pi changelog, exists.

Activity

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

Metadata

Metadata

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