Page MenuHomePhabricator

Define the format and contents Release Notes for WMDE-maintained software [8hrs]
Closed, ResolvedPublic

Description

The decision on what to include in Release Notes is going to influence how to create/generate them (not in scope of this)

Release Strategy team will investigation options and make a suggestion to be discussed in the WMDE development team. This groundwork will be timeboxed for 8 personhours.

Acceptance criteria:

  • Decision on where to publish the Release Notes has been documented
  • Decision has been made by WMDE development team and recorded on what is the intended level of detail to cover in Release Notes

Event Timeline

WMDE-leszek renamed this task from Define the format and contents Release Notes for WMDE-maintained software to Define the format and contents Release Notes for WMDE-maintained software [8hrs].Jan 5 2021, 10:29 AM
WMDE-leszek updated the task description. (Show Details)

There is a draft ADR that talks a bit about the contents already, basically copy paste of how mediawiki does it https://github.com/wmde/wikibase-release-prototype/pull/14, this could be used as some kind of inspiration.

We could maybe squeeze the result of this investigation in there or strip the part that talks about the content out into a separate ADR.

Change 656150 had a related patch set uploaded (by Tobias Andersson; owner: Tobias Andersson):
[mediawiki/extensions/Wikibase@master] wip: ADR: release notes topics

https://gerrit.wikimedia.org/r/656150

Change 658069 had a related patch set uploaded (by Tarrow; owner: Tarrow):
[mediawiki/extensions/Wikibase@master] Accept ADR0017: Wikibase release notes topics

https://gerrit.wikimedia.org/r/658069

Change 656150 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] ADR0017: Wikibase release notes topics

https://gerrit.wikimedia.org/r/656150

Change 658069 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] Accept ADR0017: Wikibase release notes topics

https://gerrit.wikimedia.org/r/658069