#3314 assigned project

RTEMS Release Notes Generator

Reported by: Chris Johns Owned by: Chris Johns
Priority: normal Milestone:
Component: admin Version:
Severity: normal Keywords: SoC ecosystem
Cc: Blocked By:
Blocking:

Description (last modified by Chris Johns)

RTEMS Release Notes Generator

Contents

  1. RTEMS Release Notes Generator
    1. Mentors
    2. Students
    3. Status
    4. Introduction
    5. Goal
    6. Prerequisite
    7. Tasks

Mentors

Chris Johns

Students

Past, Present, and Potential Students

Status

This is an existing project. The history is:

GSoC/2018

Introduction

The RTEMS release process generate the release notes from Trac. All changes on a release branch must have a ticket and the ticket is assigned the Version and Milestone. During the release process a Trac TicketQuery is run on release milestone and the resulting pages are converted to a PDF as the release notes. The Trac ticket pages are downloaded in a format suitable for parsing such as XML.

The RTEMS 4.11.3 release notes are:

https://ftp.rtems.org/pub/rtems/releases/4.11/4.11.3/rtems-4.11.3-release-notes.pdf

and all the tickets and so all the changes have been captured however the release notes have some issues.

  1. The tickets only have the descriptions and no comments. This means any discussion on the resolution of the ticket is missing.
  1. The date is relative so 4 days ago is relative to the date of the release.
  1. There are some formatting issue. See page 3/8 of the 4.11.3 notes on the link above.

Comments cannot be easily added. Trac's TicketQuery does not support adding the Comments. There has been many requests for this over the years and it has not been added.

The date is a local setting which means logging in to get a setting and the release process is anonymous and gets the default.

The formatting could be the current release process's CSS file used to generate the PDF.

Goal

  • Automatically create the release notes for a release from the Trac data.
  • Include all of the ticket's data in the release notes.
  • Use the full date.
  • Provide better formatting of the ticket such as each ticket starting on a new page.
  • Be able to provide HTML and PDF version of the output.

Prerequisite

  • Knowledge of Python
  • Knowledge of HTML and CSS
  • Knowledge of XML
  • Knowledge of ReST (Sphinx)

Tasks

  1. Develop a Python class to read an RSS page from Trac. An RSS page is basically HTML in XML.
  1. Develop a Python class to get a list of tickets for a milestone from Trac using the RSS format.
  1. Develop a Python class to get all the ticket data for a milestone.
  1. Generate ReST output that can be wrapped in coverpages to create a document.
  1. Have Sphnix generate create HTML and PDF output.
  1. Package the tool in the rtems-tools repo.
  1. Update the RTEMS release process to create the new format release notes.

Change History (4)

comment:1 Changed on Mar 1, 2018 at 1:07:22 AM by Chris Johns

Owner: set to Chris Johns
Status: newassigned

comment:2 Changed on Mar 1, 2018 at 1:14:58 AM by Chris Johns

Description: modified (diff)
Summary: RTEMS Releases Note GeneratorRTEMS Release Notes Generator

comment:3 Changed on Mar 4, 2020 at 2:20:04 AM by Chris Johns

Description: modified (diff)

comment:4 Changed on Mar 4, 2020 at 8:55:04 PM by Chris Johns

Description: modified (diff)
Note: See TracTickets for help on using tickets.