Template:Deploy/doc

Usage

On Deployments, add this template to a deployment window under the what= parameter of {{Deployment calendar event card}}, headed with your {{ircnick}}.

Initial state

Wikitext

{{ircnick|TheresNoTime|Sammy}}
{{deploy|type=config|gerrit=951042|title=IS: Enable Phonos on all projects|status=}}

Output

Sammy (TheresNoTime)

• [config] 951042 (deploy commands) IS: Enable Phonos on all projects

Deployed

Wikitext

{{ircnick|TheresNoTime|Sammy}}
{{deploy|type=config|gerrit=951042|title=IS: Enable Phonos on all projects|status=done|by=TheresNoTime}}

Output

Sammy (TheresNoTime)

• [config] 951042 (deploy commands) IS: Enable Phonos on all projects

Merged, but deployment state unknown

Wikitext

{{ircnick|TheresNoTime|Sammy}}
{{deploy|type=config|gerrit=951042|title=IS: Enable Phonos on all projects|status=unknown}}

Output

Sammy (TheresNoTime)

• [config] 951042 (deploy commands) IS: Enable Phonos on all projects

HTML

This template adds the following div/spans, which can be used to programatically parse the page;

• <div class="deploy-item"></div> around each instance of the template.
• <span class="deploy-type"></span> around the change |type=
• <span class="deploy-title"></span> around the change |title=

Selecting parameters via CSS selectors

• Change type: .deploy-item .deploy-type
• Change title: .deploy-item .deploy-title
• Gerrit change ID: .deploy-item .plainlinks a.external.text (first result) or get the data-gerrit-id (added) attribute from .deploy-item .plainlinks
• Deployment status: Get the alt attribute from .deploy-item img
• Change owner: Something like $('.deploy-item').prev('p').find('span.ircnick'); I guess?

TemplateData

No description.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Change type	type	Change type for this deployment patchset Suggested values config wmf.23 wmf.24 Example config	String	required
Gerrit changeset ID	gerrit	The Gerrit patchset ID	Number	required
Change title	title	The title of the patchset	String	required
Deployment status	status	Deployment status of this patchset. When not set, defaults to pending Suggested values d done deployed nd not done not deployed m merged unknown	String	optional
Deployed by	by	Who the patchset was deployed (or not deployed) by Example TheresNoTime	String	optional
SAL entry link	sal	Full URL to SAL entry Example https://sal.toolforge.org/log/u0SWRooBGiVuUzOdEfAd	URL	optional