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

Changelog question #114

Open
VikingTristan opened this issue Aug 15, 2019 · 2 comments
Open

Changelog question #114

VikingTristan opened this issue Aug 15, 2019 · 2 comments
Labels
question Further information is requested

Comments

@VikingTristan
Copy link
Contributor

Changelog history is deleted after every release.

From current README.md:

After pushing to master, complete the following steps:

  1. Change back to develop.
  2. Remove the content of changelog (leave the heading).
  3. Commit the file and push it.

A user doesn't sit and read every changelog that happen from every release. A user will read it when deciding to update. This is a problem when the changelog only contains the latest update.
Consider the following:

User has version 1.5.0.
Current release is 2.1.0.
Changelog will now only contain updates from 2.0.x to 2.1.0.

User is now 😥

Possible implementations 1 2

@VikingTristan VikingTristan added the question Further information is requested label Aug 15, 2019
@erikhallaraaker
Copy link
Contributor

This is how the changelog was originally. However when we implemented github releases we made appveyor read the content of the changelog and add it to the release. A workaround would be to add a (temporary?) file with the current changes for the release and have appveyour attach these instead.

@VikingTristan
Copy link
Contributor Author

Ah, I see.

Yes. A RELEASE-NOTES.md. Perhaps its content can be generated aswell.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants