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+- url: /home/myuser/ladybug-0.0.1.wasm
2+  name: ladybug

Commit your change and push git add . && git commit -m "install ladybug 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 - url: /home/myuser/ladybug-0.0.1.wasm
 2   name: ladybug
 3+  active: false
 4+  run:
 5+  - path: issues/**/*.md
 6+    branch:
 7+    - "*"
 8+    when:
 9+    - add
10+    - mod
11+    write:
12+      git:
13+      - path: issues/**/*.md
14+        can:
15+        - mod
16+      web: []
17+    configuration:
18+      metadata:
19+      - default: autogenerated
20+        mandatory: true
21+        name: id
22+        type: crc16
23+      - default: 50.0
24+        mandatory: true
25+        name: priority
26+        type: int
27+      - default: null
28+        mandatory: false
29+        name: assignee
30+        type: user
31+      - default: triage
32+        mandatory: false
33+        name: status
34+        type: string
35+      - default: issue
36+        mandatory: false
37+        name: kind
38+        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 directly activate a plugin