Release Docs Update
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	roti_WMDE
	Nov 21 2023, 2:36 PM

Description

Current Situation:

The release process is quite manual at the moment. We are currently changing some pieces to make the release more automatic. Those pieces that are then not documented anymore.

Goal:

Keep the documentation of the release process up to date

Acceptance Criteria:

this document is up to date with the latest process guidelines
The Phabricator Ticket used for releases reflects the new process and contains enough information to guide the user through the process

[optional] Notes:

blocked on T351720
relevant too T341450
do it together with the next release

[optional] Open Questions:

Details

Other Assignee: adee_wmde

Related Objects

Mentioned In: T358749: Release announcement contents
T343433: Automate the wbSuite Release Process
Mentioned Here: T354644: Release WMDE.17 - (MediaWiki 1.41.0)
T341450: ask people on LOD casual chat about releasing secret/security fixes with wbs releases
T351720: Implement GH actions based release automation

Event Timeline

roti_WMDE created this task.Nov 21 2023, 2:36 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptNov 21 2023, 2:36 PM

roti_WMDE updated the task description. (Show Details)Nov 21 2023, 3:16 PM

roti_WMDE added a project: Speedier Release.Nov 21 2023, 3:26 PM

darthmon_wmde mentioned this in T343433: Automate the wbSuite Release Process.Nov 21 2023, 3:39 PM

I would be for documenting the release process (and list all the steps) on the GH repo of the release pipeline and just set that document as deprecated

roti_WMDE updated the task description. (Show Details)Dec 5 2023, 1:54 PM

roti_WMDE updated the task description. (Show Details)

roti_WMDE moved this task from Sprint-∞ to Prioritised + Refined (top to bottom - ready to work on i.e. throw in a sprint) on the Wikibase Suite Team board.Dec 5 2023, 1:57 PM

roti_WMDE edited projects, added Wikibase Suite Team; removed Wikibase Suite Team (Sprint-∞).

roti_WMDE updated the task description. (Show Details)

roti_WMDE moved this task from Prioritised + Refined (top to bottom - ready to work on i.e. throw in a sprint) to Next Focus (prioritised top to bottom + unrefined) on the Wikibase Suite Team board.Dec 5 2023, 2:28 PM

roti_WMDE added a project: wbSuite Release Pipeline.

roti_WMDE moved this task from Next Focus (prioritised top to bottom + unrefined) to Prioritised + Refined (top to bottom - ready to work on i.e. throw in a sprint) on the Wikibase Suite Team board.

roti_WMDE moved this task from Prioritised + Refined (top to bottom - ready to work on i.e. throw in a sprint) to Sprint-∞ on the Wikibase Suite Team board.Feb 5 2024, 8:45 AM

roti_WMDE edited projects, added Wikibase Suite Team (Sprint-∞); removed Wikibase Suite Team.

adee_wmde changed the task status from Open to In Progress.Feb 6 2024, 2:52 PM

adee_wmde claimed this task.

adee_wmde moved this task from To do to Doing on the Wikibase Suite Team (Sprint-∞) board.

adee_wmde moved this task from Doing to To do on the Wikibase Suite Team (Sprint-∞) board.Feb 13 2024, 5:45 PM

lojo_wmde moved this task from To do to Doing on the Wikibase Suite Team (Sprint-∞) board.Feb 15 2024, 11:44 AM

danshick-wmde subscribed.Feb 22 2024, 11:42 AM

On the release announcement/community comms side I think we need the announcement to contain:

a list of all code & config changes, breaking and otherwise
a working link to the release tag (which means the release needs to happen after the announcement)
links to current install & upgrade documentation
an indication of where they can turn for support (and an initial sense of what level of support they can expect)

The section "release checklist in a more wordy way" of our Introduction to the Wikibase release pipeline is updated with a detailed explanation of the current checklist. We should keep updating it as we change our process.

An updated version of the ticket checklist is now ready for the next release WMDE.17 https://phabricator.wikimedia.org/T354644

@danshick-wmde Thanks a lot for the input. Should we create a new ticket for that? This ticket was more about our internal checklist to guide ourselves through the release process.

In T351723#9567238, @danshick-wmde wrote:

On the release announcement/community comms side I think we need the announcement to contain:

a list of all code & config changes, breaking and otherwise

a working link to the release tag (which means the release needs to happen after the announcement)

links to current install & upgrade documentation

an indication of where they can turn for support (and an initial sense of what level of support they can expect)

Sure, if you see that as out of scope for this ticket, I'm happy to create a new one.

In T351723#9582898, @roti_WMDE wrote:

@danshick-wmde Thanks a lot for the input. Should we create a new ticket for that? This ticket was more about our internal checklist to guide ourselves through the release process.

In T351723#9567238, @danshick-wmde wrote:

On the release announcement/community comms side I think we need the announcement to contain:

a list of all code & config changes, breaking and otherwise

a working link to the release tag (which means the release needs to happen after the announcement)

links to current install & upgrade documentation

an indication of where they can turn for support (and an initial sense of what level of support they can expect)