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: https://registry.com/path/to/plugin.wasm
2+  checksum: "sha256:0c755bb2dc5cc037216b29ba1709875afee425ee429b6be97f0d5e137067acff"

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: url: https://registry.com/path/to/plugin.wasm
 2   checksum: "sha256:0c755bb2dc5cc037216b29ba1709875afee425ee429b6be97f0d5e137067acff"
 3+  name: ladybug
 4+  active: false
 5+  run:
 6+  - path: issues/**/*.md
 7+    branch:
 8+    - "*"
 9+    when:
10+    - add
11+    - mod
12+    write:
13+      git:
14+      - path: issues/**/*.md
15+        can:
16+        - mod
17+      web: []
18+    configuration:
19+      metadata:
20+      - default: autogenerated
21+        mandatory: true
22+        name: id
23+        type: crc16
24+      - default: 50.0
25+        mandatory: true
26+        name: priority
27+        type: int
28+      - default: null
29+        mandatory: false
30+        name: assignee
31+        type: user
32+      - default: triage
33+        mandatory: false
34+        name: status
35+        type: string
36+      - default: issue
37+        mandatory: false
38+        name: kind
39+        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 URLs, checksums and more go on the gitroot registry.