GitRoot

Craft your forge // Build your project // Grow your community freely

Install a plugin

To install a plugin you can simply add the lines corresponding and GitRoot will install it.

Open .gitroot/plugins.yml in the root repository:

1+- purl: pkg:gitroot/$scope/$name@$version?checksum=$checksum&registry=$url

To find purl for all plugins go into the plugin registry.

Commit your change and push git add . && git commit -m "install plugin" && git push. When the change will be in the defaultBranch GitRoot will copy it to their data. Then it will instantiate it and grab their default configuration.

So after a git pull you should see:

 1 - purl: pkg:gitroot/$scope/$name@$version?checksum=$checksum&registry=$url
 2+  active: false
 3+  run:
 4+  - path: issues/**/*.md
 5+    branch:
 6+    - "*"
 7+    when:
 8+    - add
 9+    - mod
10+    write:
11+      git:
12+      - path: issues/**/*.md
13+        can:
14+        - mod
15+      web: []
16+    configuration:
17+      metadata:
18+      - default: autogenerated
19+        mandatory: true
20+        name: id
21+        type: crc16
22+      - default: 50.0
23+        mandatory: true
24+        name: priority
25+        type: int
26+      - default: null
27+        mandatory: false
28+        name: assignee
29+        type: user
30+      - default: triage
31+        mandatory: false
32+        name: status
33+        type: string
34+      - default: issue
35+        mandatory: false
36+        name: kind
37+        type: string

If you see that, congratulation, your plugin is correctly installed. GitRoot has pushed a commit with this configuation on all of the repositories of your instance.

But don’t panic, has you can see the plugin does nothing because it is inactive.

Read more on plugin rights or activate a plugin.

To find plugin PURLs and more go on the gitroot registry.