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

Bundle full changelog with your extension #319

Open
jerone opened this issue Feb 21, 2023 · 2 comments
Open

Bundle full changelog with your extension #319

jerone opened this issue Feb 21, 2023 · 2 comments

Comments

@jerone
Copy link

jerone commented Feb 21, 2023

Please bundle the full changelog with your extension.

This allows users to see all changes under the 'Version history' tab in the Marketplace (for example https://marketplace.visualstudio.com/items/ryu1kn.extension-update-reporter/changelog).

And it allows Extension Update Reporter extension to correctly display your changelog.
image

I'm seeing that you are bundling some sort of "mini changelog". Why is that needed?
I would advice to bundle the full CHANGELOG.md file.

@jerone
Copy link
Author

jerone commented Feb 21, 2023

On a separate note, I see that your changelog doesn't follow the Keep a Changelog guideline principles anymore after version 4.0.9.
Specifically:

  • Versions and sections should be linkable.
  • The release date of each version is displayed.

@jerone
Copy link
Author

jerone commented Feb 21, 2023

Another note: you might want to exclude some files when publishing:
image

Keeps the extension small and clean.

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