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

Set up release notes #28

Closed
jtniehof opened this issue Sep 30, 2020 · 4 comments · Fixed by #50
Closed

Set up release notes #28

jtniehof opened this issue Sep 30, 2020 · 4 comments · Fixed by #50
Assignees
Labels
documentation Issues that can be addressed with docs (docstrings, sphinx, wiki) enhancement New feature or feature request

Comments

@jtniehof
Copy link
Member

We should have a basic release notes setup (sort of like https://numpy.org/doc/stable/release.html that can also be incorporated into the github release page, again e.g. https://github.com/numpy/numpy/releases .) The PR template should also be updated to reference updating the release notes instead of CHANGELOG.

Closure condition

This issue should be closed when: we have a basic release notes included in the repository, including directions for including in the release (i.e. stub out how-to-release documentation), and the PR template updated to reference the release notes instead of CHANGELOG.

@jtniehof jtniehof added documentation Issues that can be addressed with docs (docstrings, sphinx, wiki) enhancement New feature or feature request labels Sep 30, 2020
@jtniehof
Copy link
Member Author

Numpy includes a list of merged PRs: https://numpy.org/doc/stable/release/1.17.5-notes.html#pull-requests-merged This might be fun although tricky (the PR that includes a change should include the update that links that PR from the release notes? Does numpy have a script that does this for them?)

Maybe also include the issues closed.

What this does is allows a very fine-grained presentation of what happened without having to copy/paste all history into the PR.

@jtniehof
Copy link
Member Author

It looks like numpy uses a changelog that gets processed into the release notes using towncrier. The changelog is made partially from github using a custom numpy tool that doesn't look too huge so it's probably worth just reimplementing for our purposes with those ideas.

I think a high-level summary + list of PRs merged + list of issues closed will probably do the trick for us. It doesn't look like the numpy changelog is as detailed as, say, the SpacePy changelog.

@jtniehof
Copy link
Member Author

Sample of what the auto-generated changelog for release notes could look like...happy to have formatting/content comments. (E.g. do we want date closed?)

changelog

@jtniehof
Copy link
Member Author

jtniehof commented Oct 23, 2020

My intention here is to have enough information that if Github disappeared, we wouldn't have a full archive of discussion but there'd be enough to have some idea of how commits relate to the intention of pull requests and issues they address. (Although with the GitHub API it would be possible to pull pretty close to a full record, if we wanted an exhaustive changelog somewhere...at least we could include body instead of just title of PR/issue.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues that can be addressed with docs (docstrings, sphinx, wiki) enhancement New feature or feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant