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

docs: Add OpenEdX Release Notes Checklist to Repo. #313

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/templates/openedx-release-notes-checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### Things that _can be done_ before the release is cut
- [ ] find the date for the previous release (for Olive, this was October 11, 2022)
- [ ] find the date for the next release (for Palm, this was April xx, 2022)
Comment on lines +2 to +3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how is this information used?

- [ ] Create a wiki page for the _next_ release, on the [Open edX Release Planning](https://openedx.atlassian.net/wiki/spaces/COMM/pages/13205845) wiki page ([Redwood](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3890380898/Next+Release+Redwood))
### Things to do after the release is cut
- [ ] add an appropriate TOC to the release notes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's TOC?

- [ ] add any items from the [Pending Release wiki page](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3726802953/Pending+Release+Quince)
- [ ] Review and incorporate any feature posts from [edX Partner announcements](https://partners.edx.org/announcements)
- [ ] Review and incorporate any feature posts from the [open edX blog](https://open.edx.org/category/blog/)
- [ ] Review commit messages from relevant repos. [Dinghy](https://github.com/nedbat/dinghy) seems like a useful tool for this. I used this config [olive-dinghy.yaml](https://gist.github.com/pdpinch/a1749421cc2af23f9d9a2335e065489b)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what should we do with the commit messages?

- [ ] Review [DEPR tickets ](https://openedx.atlassian.net/secure/RapidBoard.jspa?rapidView=452)
- [ ] Diff the technical documentation and build a list of links to both new and removed settings.
### Meta tasks
- [ ] Review and update this checklist
Comment on lines +2 to +14
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [ ] find the date for the previous release (for Olive, this was October 11, 2022)
- [ ] find the date for the next release (for Palm, this was April xx, 2022)
- [ ] Create a wiki page for the _next_ release, on the [Open edX Release Planning](https://openedx.atlassian.net/wiki/spaces/COMM/pages/13205845) wiki page ([Redwood](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3890380898/Next+Release+Redwood))
### Things to do after the release is cut
- [ ] add an appropriate TOC to the release notes
- [ ] add any items from the [Pending Release wiki page](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3726802953/Pending+Release+Quince)
- [ ] Review and incorporate any feature posts from [edX Partner announcements](https://partners.edx.org/announcements)
- [ ] Review and incorporate any feature posts from the [open edX blog](https://open.edx.org/category/blog/)
- [ ] Review commit messages from relevant repos. [Dinghy](https://github.com/nedbat/dinghy) seems like a useful tool for this. I used this config [olive-dinghy.yaml](https://gist.github.com/pdpinch/a1749421cc2af23f9d9a2335e065489b)
- [ ] Review [DEPR tickets ](https://openedx.atlassian.net/secure/RapidBoard.jspa?rapidView=452)
- [ ] Diff the technical documentation and build a list of links to both new and removed settings.
### Meta tasks
- [ ] Review and update this checklist
- [ ] find the date for the previous release (for Olive, this was October 11, 2022)
- [ ] find the date for the next release (for Palm, this was April xx, 2022)
- [ ] Create a wiki page for the _next_ release, on the [Open edX Release Planning](https://openedx.atlassian.net/wiki/spaces/COMM/pages/13205845) wiki page ([Redwood](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3890380898/Next+Release+Redwood))
### Things to do after the release is cut
- [ ] Add an appropriate TOC to the release notes
- [ ] Add any items from the [Pending Release wiki page](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3726802953/Pending+Release+Quince)
- [ ] Review and incorporate any feature posts from [edX Partner announcements](https://partners.edx.org/announcements)
- [ ] Review and incorporate any feature posts from the [Open edX blog](https://openedx.org/category/blog/)
- [ ] Review commit messages from relevant repos. [Dinghy](https://github.com/nedbat/dinghy) seems like a useful tool for this. I used this config [olive-dinghy.yaml](https://gist.github.com/pdpinch/a1749421cc2af23f9d9a2335e065489b)
- [ ] Review [DEPR tickets ](https://openedx.atlassian.net/secure/RapidBoard.jspa?rapidView=452)
- [ ] Diff the technical documentation and build a list of links to both new and removed settings.
### Meta tasks
- [ ] Review and update this checklist