Date: 2021-01-14
accepted
We have in ADR0005 proposed a process for maintaining our release notes within the repository we also want to make a decision as to where these should be published for a broader audience.
As our process for maintaining release notes will be closely modeled after mediawiki it also makes sense to review how mediawiki is publishing theirs.
As described in ADR0005, mediawiki is maintaining release notes for each specific release within the corresponding release branch. During the preparation of creating a new release from the development branch, a new release branch is cut and the template that has been populated with the relevant changes from the ongoing development is to serve as the base for a richer curated version on mediawiki.org (Example: 1.35).
The release notes document within the repository does not contain the full links to documentation or phabricator tickets but is supported by templates to generate these dynamically.
For links to phabricator the task number is used by the PhabT template which also supports linking to comments, this could easily be re-used by WMDE as we are also using phabricator.
=== Changes since MediaWiki 1.35.0 ===
* () purgeList.php Fix all-namespaces option to match one used in code.
For links to documentation topics referring to the mediawiki manual the Localized link template is used to generate these.
==== New configuration ====
* — This can be used to specify the difference engine to use, rather than MediaWiki choosing the first of , wikidiff2, or php that is usable.
As the Wikibase documentation is not maintained on mediawiki.org an alternative template would need to be created to support similar links to the Wikibase documentation. A review and update of the documentation is also required as not all links currently support linking to documentation topics by their canonical name.
$wgWBRepoSettings['changesDatabase']
https://doc.wikimedia.org/Wikibase/master/php/md_docs_topics_options.html#changesDatabase
$wgWBRepoSettings['useChangesTable']
https://doc.wikimedia.org/Wikibase/master/php/md_docs_topics_options.html#autotoc_md251
Adopt a similar process to that of mediawiki and publish release notes on mediawiki.org