SCM Macro

Last modified by Vincent Massol on 2024/04/09

Macro to use when referencing code in a scm.

Examples:

{{scm/}}

{{scm project="xwiki-rendering"/}}

{{scm project="xwiki-commons" path="xwiki-commons-core/pom.xml"/}}

{{scm branch="stable-3.1.x" path="xwiki-platform-core/pom.xml"/}}

{{scm path="xwiki-platform-core/pom.xml"/}}

{{scm branch="stable-3.1.x" path="xwiki-platform-core/pom.xml"}}With **label**{{/scm}}

{{scm branch="stable-3.1.x" path="xwiki-platform-core/pom.xml" raw="true"/}}

Results:

http://www.github.com/xwiki

http://www.github.com/xwiki/xwiki-rendering

http://www.github.com/xwiki/xwiki-commons/tree/master/xwiki-commons-core/pom.xml

http://www.github.com/xwiki/xwiki-platform/tree/stable-3.1.x/xwiki-platform-core/pom.xml

http://www.github.com/xwiki/xwiki-platform/tree/master/xwiki-platform-core/pom.xml

With label

http://raw.github.com/xwiki/xwiki-platform/stable-3.1.x/xwiki-platform-core/pom.xml

Parameters

 Parameter name  Default value  Description
 user  xwiki  the github user
 project  xwiki-platform  the repository name in the provided user
 branch  master  the branch or tag
 raw  false  UI or raw content
 path  empty string  the resource in the repository

Get Connected