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

Track release notes in the repository #6759

Closed
3 tasks done
ddbeck opened this issue Sep 23, 2020 · 2 comments
Closed
3 tasks done

Track release notes in the repository #6759

ddbeck opened this issue Sep 23, 2020 · 2 comments
Labels
docs Issues or pull requests regarding the documentation of this project.

Comments

@ddbeck
Copy link
Collaborator

ddbeck commented Sep 23, 2020

Right now, release notes are in GitHub's releases page only. This is probably OK, but it would be good to put them into git. This would make writing release notes collaborative and incremental, add a layer of review, and duplicate them outside a proprietary tool.

To do this we'd need:

  • copy existing release notes into a RELEASE_NOTES.md or similar
  • docs for how to write and update the notes
  • change the release notes script to update the file and use it as a source for adding a new release to GitHub
@ddbeck ddbeck added the docs Issues or pull requests regarding the documentation of this project. label Sep 23, 2020
@queengooborg
Copy link
Contributor

I believe it's safe to close this issue, as you've now done every step in that checklist?

@ddbeck
Copy link
Collaborator Author

ddbeck commented May 12, 2021

Yes, thank you!

@ddbeck ddbeck closed this as completed May 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues or pull requests regarding the documentation of this project.
Projects
None yet
Development

No branches or pull requests

3 participants
@ddbeck @queengooborg and others