Template:Github

example/file.php

Template documentation[view] [edit] [history] [purge]

This template provides an alternative to {{git file}} for linking to source code.

This uses the GitHub mirror instead of Diffusion the Gitblit server at git.wikimedia.org (WMF is deprecating gitblit and git.wikimedia.org in 2015). Editors may find GitHub's interface more user-friendly, faster responding, visually appealing, or otherwise preferable. Compare:

• diffusion link ← {{git file|file=index.php|text=diffusion link|line=39|branch=REL1_25}}
• github link ← {{github|index.php|github link|line=39|branch=REL1_25}}

Usage

Basic

 {{github |file=composer.json }}
 {{github |repo=mediawiki-extensions-Flow |file=composer.json }}

produces:

composer.json

composer.json

Action

{{github |repo=mediawiki-extensions-EventLogging 
 |file=server/bin/eventlogging-devserver
 |text=development server | action=raw }}

produces:

development server

Line number

{{github |file=tests/phpunit/includes/MessageTest.php |line=152 }}

produces:

tests/phpunit/includes/MessageTest.php

A convenient way of linking to source code.

Template parameters

Parameter		Description	Type	Status
Repo	repo	Full repository name (e.g. "mediawiki" or "mediawiki/extensions/EventLogging"). Must not include any ".git" suffix. Default mediawiki	String	optional
Action	action	A GitHub repo action. One of "blob", "raw", "blame", "commits", or "tree" Default blob	String	optional
Branch	branch	no description Default master	String	optional
File	file	no description Default	String	required
Line	line	no description	Number	optional
Text	text	Custom label for the link created by this template. Default The file path	String	optional

See also

• {{Git file}}
• {{Git}}
• {{GithubDownload}}

The above documentation is transcluded from Template:Github/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.