Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add changelog when publishing #212

Open
dploeger opened this issue Mar 13, 2019 · 5 comments
Open

Add changelog when publishing #212

dploeger opened this issue Mar 13, 2019 · 5 comments

Comments

@dploeger
Copy link

As a user I want to see, what has changed in the current release of a Sketch plugin before installing it. For that I can refer to the "embedded changelog" feature of the appcast.xml, to a CHANGELOG file inside the plugin repository or to the page of each release on GitHub.

As a developer I'd like skpm to automatically generate changelog entries based on the commits created between the new release and the prior release upon publishing the new release. Commits should only be enclosed in the changelog if the commit message sticks to the [conventional commits specification].

The changelog should be added to a repository-local CHANGELOG file, to the release comment on GitHub and to the Appcast.xml file.

@mathieudutour
Copy link
Member

Sketch doesn't handle changelog yet so it wouldn't useful for skpm to generate it

@dploeger
Copy link
Author

But still it would be usable for users. 😉 And perhaps some day Sketch (or something like Runner) might use it.

@mathieudutour
Copy link
Member

possibly yes, but for now there wouldn't be much value and there are already tons of tools to generate a changelog. You could totally use one of them at the same time as skpm

@dploeger
Copy link
Author

Okay. Should we still keep this issue open for future?

@mathieudutour
Copy link
Member

yes, it's something I'll think about

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

No branches or pull requests

2 participants