Skip to content

Commit 3e239d3

Browse files
authored
Disable all plugins by default (#16)
Disabled plugins so users dont have to deal with errors like "missing DISCORD_TOKEN" and instead can choose to opt in to only the plugins they want to use. Test Plan: Ensure no plugins are loaded / run when calling SourceCred commands
1 parent c95262c commit 3e239d3

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,20 @@ Generated Data:
4040
# Setup and Usage
4141

4242
Using this instance as a starting point, you can update the config to include
43-
just the plugins you want, pointing at the data you care about. We recommend setting up
43+
the plugins you want, pointing at the data you care about. We recommend setting up
4444
your instance locally first and make sure its working before pushing your changes
4545
to master and using the Github Action.
4646

4747
Get [Yarn] and then run `yarn` to install SourceCred and dependencies.
4848

49+
Enable the plugins you want to use by updating the `sourcecred.json` file. e.g.
50+
to enable all the plugins:
51+
```json
52+
{
53+
"bundledPlugins": ["sourcecred/discourse", "sourcecred/discord", "sourcecred/github"]
54+
}
55+
```
56+
4957
Update the configuration files according to the plugin guides below.
5058

5159
Then, run the following commands to update the instance:

sourcecred.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"bundledPlugins": ["sourcecred/discourse", "sourcecred/discord", "sourcecred/github"]
2+
"bundledPlugins": []
33
}

0 commit comments

Comments
 (0)