Open main menu

Template:Github

example/file.php

Template documentation


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}}

UsageEdit

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

ParameterDescriptionTypeStatus
Reporepo

Full repository name (e.g. "mediawiki" or "mediawiki/extensions/EventLogging"). Must not include any ".git" suffix.

Default
mediawiki
Stringoptional
Actionaction

A GitHub repo action. One of "blob", "raw", "blame", "commits", or "tree"

Default
blob
Stringoptional
Branchbranch

no description

Default
master
Stringoptional
Filefile

no description

Default
Stringrequired
Lineline

no description

Numberoptional
Texttext

Custom label for the link created by this template.

Default
The file path
Stringoptional

See alsoEdit