Details
-
Technical task
-
Resolution: Done
-
P2: Important
-
None
-
None
Description
Based on discussions we should use markdown format in release notes. So
- Let's convert release-note.txt -> release-note.md
- Use same general formatting in release-note.md as in https://code.qt.io/cgit/qt-creator/qt-creator.git/tree/dist/changes-4.15.0.md
- Headers
- Lists
Like this:
Release note ============ < release note header here> Important Changes ----------------- ### Module * <SHA1> <Subject> < [ChangeLog] message > * <SHA1> <Subject> < [ChangeLog] message > Fixes -------- ### Module * <Bug ID> <Subject> * <Bug ID> <Subject> Known Issues: ----------------------- Credits for the release goes to: ------------------------------------------------- < list of contributors>
That way we could get much more readable document (like https://code.qt.io/cgit/qt-creator/qt-creator.git/about/dist/changes-4.15.0.md )
Attachments
For Gerrit Dashboard: QTBUG-93695 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
349714,5 | generate_release_note.py: Use markdown syntax | master | qtsdk/tqtc-qtsdk | Status: MERGED | +2 | 0 |