You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We recommend organizing your plugin with the following directory structure, where the top-level folder matches the name of your plugin:
17
+
We recommend organizing your plugin with the following directory structure, where the top-level folder matches the name of your plugin:
18
18
19
19
```
20
20
my-plugin/
@@ -98,12 +98,6 @@ The name of your plugin. This is used to identify your plugin when a user runs `
98
98
99
99
The version of your plugin. You should start your version at 0.0.1 and bump it whenever you merge an update to the plugin.
100
100
101
-
#### `match`*string*
102
-
103
-
A regex expression that is used to identify when the plugin will be activated. Devbox will activate your plugin when a package installed with `devbox add` matches this regular expression.
104
-
105
-
The regex you provide should match a package name to automatically update. You can look up packages at `nixhub.io`
106
-
107
101
#### `readme`*string*
108
102
109
103
Special usage instructions or notes to display when your plugin activates or when a user runs `devbox info`. You do not need to document variables, helper files, or services, since these are automatically printed when a user runs `devbox info`.
@@ -128,7 +122,7 @@ You should use this to copy starter config files or templates needed to run the
128
122
129
123
#### `shell.init_hook`*string | string[]*
130
124
131
-
A single `bash` command or list of `bash` commands that should run before the user's shell is initialized.
125
+
A single `bash` command or list of `bash` commands that should run before the user's shell is initialized.
132
126
133
127
This will run every time a shell is started, so you should avoid any resource heavy or long running processes in this step.
134
128
@@ -145,15 +139,15 @@ See the process compose [docs](https://github.com/F1bonacc1/process-compose) for
145
139
Testing plugins can be done using an example Devbox project. Follow the steps below to create a new test project
146
140
147
141
1. Create a new `devbox.json` in an empty directory using `devbox init`.
148
-
2. Add your plugin to the `include` section of the `devbox.json` file.
142
+
2. Add your plugin to the `include` section of the `devbox.json` file.
149
143
2. Add any expected packages using `devbox add <pkg>`.
150
144
3. Check that your plugin creates the correct files and environment variables when running `devbox shell`
151
145
4. If you are looking for sample projects to test your plugin with, check out our [examples](https://github.com/jetpack-io/devbox/tree/main/examples).
152
146
153
147
154
148
## Example: MongoDB
155
149
156
-
The plugin.json below sets the environment variables and config needed to run MongoDB in Devbox. You can view the full example at
150
+
The plugin.json below sets the environment variables and config needed to run MongoDB in Devbox. You can view the full example at
0 commit comments