.. | ||
extension.rb | ||
README.adoc |
An inline macro for easily linking objects from GitLab instances.
Attributes
-
domain
is the base domain of the GitLab instance. By default, it points to the official instance ofgitlab.com
. -
rev
is the commit of the repo. By default. it doesn’t point to anything which should be in the default branch of the repository. -
path
is the filepath to be linked. -
issue
is the issue to be linked from the repo. Take note issue has higher precedence so oncedomain
andissue
are both set, it will still link to an issue.
There are settings that is enabled with the options attribute.
-
repo
sets the default caption to be the repo part.
Example usage
-
gitlab:gitlab-org/gitlab[]
will link to the GitLab’s source code with the default domain. -
gitlab:gitlab-org/gitlab[rev=0c9f77389424b6c5fd8e96b227e9125a13a07cb3, path=README.md]
should link to the GitLab’s README from 3 years ago. -
gitlab:GNOME/mutter[domain=gitlab.gnome.org, rev=df653b95adf6462fc731998eb53b0860baa7253c, path=meson.build]
should link to Mutter v44.betameson.build
from GNOME GitLab instance.