#1796 Mandatory Release notes for Changes
Closed: Fixed 10 months ago by jkurik. Opened 11 months ago by jkurik.

For a long time we have an issue with readiness of Release notes for a release. As the Documentation team is now working on automation of their tasks & infrastructure, @bex , as a representative of the Documentation team, has initiated a discussion on the Release notes topic. Me and @bex met and we came up with the following process for Release notes:

  1. When a Change is approved it needs to have associated a Release notes ticket in Pagure
  2. One week before Beta Freeze PgM requests from Doc team to build Release notes providing the Doc team with a list of Changes planned for a release.
  3. Doc team builds the Release notes package.
  4. During review of Changes for 100% completeness (done by FESCo) is readiness of Release notes taken into account as one of criterions to block a Change from being released as part of a Fedora release.
  5. Doc team does refresh of Release notes according to the list of Changes approved by FESCo and provides a new version of Release notes package.
  6. Doc team requests Freeze Exception for Beta to include the latest build of Release Notes package into the Beta compose.
  7. It is not expected there will be major changes in Release notes between end of Beta Freeze and beginning of Final Freeze, however the Doc team might be asked during this period to refresh the Release notes package with a new content if needed.

I would like to ask FESCo to review this policy (I plan to use it as an addendum to Changes Policy) and provide approval or comments. I am especially concern about point #4 , which enforces Release notes as a mandatory part of every Change.


Metadata Update from @jkurik:
- Issue tagged with: meeting

11 months ago

Sounds good to me. Is there a description of the minimum requirements for a release not entry? Does a single sentence such as "Ruby was updated to version XY to match the lastest upstream release."?

Sounds good to me. Is there a description of the minimum requirements for a release not entry? Does a single sentence such as "Ruby was updated to version XY to match the lastest upstream release."?

Take a look at the example, draft, not finalized, issue template here: https://pagure.io/fedora-docs/release-notes/new_issue

In short release notes need to be useful to the domain expert and ideally useful to others who may get excited.

I'm +1 to this proposal.

AGREED: Mandatory release notes are approved (+7,0,2) (nirik, 16:48:16)

Metadata Update from @kevin:
- Issue close_status updated to: Fixed
- Issue status updated to: Closed (was: Open)

10 months ago

Login to comment on this ticket.

Metadata