Add release notes #1108
Merged
Add release notes #1108
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds release notes to the project, both the github repo and the project documentation.
The new file
CHANGELOG.rstcontains the actual release notes, and this file is pulled into the docs when they are built. The contents of the file were pulled from each of the github releases and then various regexes were used to generate links for PRs, users, etc.The rendered output is here: https://github.com/ianthomas23/datashader/blob/release_notes/CHANGELOG.rst
In future, before tagging a release the CHANGELOG should be updated with the changes for that release, and after the release and building of PyPI and conda packages the github release can be performed by copy and pasting from the CHANGELOG.