Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-90232 Updated release note process
  3. QTBUG-93695

Use markdown format in release notes

    XMLWordPrintable

Details

    • Technical task
    • Resolution: Done
    • P2: Important
    • None
    • Packaging & Installer
    • None

    Description

      Based on discussions we should use markdown format in release notes. So

      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

        Activity

          People

            ankokko Antti Kokko
            janihe Jani Heikkinen
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes