Page MenuHomePhabricator

Write release notes for kartotherian deployment
Closed, ResolvedPublic2 Estimated Story Points

Description

  • Find a nice home for posting release notes on an ongoing basis.
  • Take the git log for this release and turn it into short English summaries of the new features and any breaking changes or new configuration:
git log --reverse 2ef5c2d...e91c46a

Release notes

User experience

  • New feature: New support for geopoints, given Wikidata IDs or a custom SPARQL query (T307695).
    • Enabled on the beta cluster but not in production yet.
  • Bugfix: When duplicate Wikidata IDs appear, don't crash. Merge or render them all (T306540).
  • Bugfix: Hide unwanted markers from rendered geolines (T292613).

Technical debt

These are tracked under T302053.

  • Update linters to the newest versions still supporting node 10.
  • Replace some promises with async/await.
  • Refactor geoshapes as pure functions.
  • Diagram illustrating the versioned maps data flow (T294338).
  • Fail faster when the geoshapes endpoint is down (T307671).

Event Timeline

WMDE-Fisch set the point value for this task to 2.Jun 9 2022, 12:17 PM
awight updated the task description. (Show Details)
awight updated the task description. (Show Details)
awight updated the task description. (Show Details)

Great overview, @awight. I have some small adjustments:

New feature: New support for geopoints, given Wikidata IDs (T305822)

I would link to the epic instead: T307695

Bugfix: Don't crash when duplicate Wikidata IDs appear (T306540).

Maybe we could add which approach we selected to achieve this?

Bugfix: Hide markers from rendered geolines (T292613).

I would add: Hide unwanted markers ...

Technical debt

  • Update linters to the newest versions still supporting node 10.
  • Replace some promises with async/await.
  • Refactor geoshapes as pure functions.

Do we have links for these three points as well?

I have some small adjustments:

Thanks for the help! I've adjusted the notes according to your suggestions.

Do we have links for these three points as well?

These were a bit under the radar, the changes were made without associated tasks. IMHO we shouldn't link to the (many) gerrit patches because it will clutter the notes with information that would be easier for the appropriate audience to find by reading through the code or commit log themselves. But this is based on assumptions, let me know if you think otherwise.

IMHO we shouldn't link to the (many) gerrit patches because it will clutter the notes with information

Agreed. Maybe we could create a tech cleanup ticket and list the patches there retroactively? 🤔

Lena_WMDE renamed this task from Write release notes for June 2022 kartotherian deployment to Write release notes for kartotherian deployment.Jul 6 2022, 7:17 AM
  • Bugfix: When duplicate Wikidata IDs appear, don't crash. Merge or render them all (T306540).

I think we decided to render them all and not merge. We should update this here.

  • Find a nice home for posting release notes on an ongoing basis.

Maybe here https://github.com/wikimedia/mediawiki-services-kartotherian/tree/master/docs? @thiemowmde?

Change 817288 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/services/kartotherian@master] Start a release-notes.md file

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

Change 817288 merged by jenkins-bot:

[mediawiki/services/kartotherian@master] Start a changelog.md file

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

Change 819092 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/services/kartotherian@master] Add Phabricator links to the new changelog

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

Change 819092 merged by jenkins-bot:

[mediawiki/services/kartotherian@master] Add Phabricator links to the new changelog

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

thiemowmde claimed this task.