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
Copy file name to clipboardExpand all lines: README.md
+18-13Lines changed: 18 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,23 +12,28 @@ This repository exists to provide a secure, version-controlled collection of plu
12
12
13
13
Whether you're a plugin developer submitting updates or a user browsing available extensions, this database serves as the trusted source for all Millennium-compatible plugins.
14
14
15
-
## Submitting A Plugin
15
+
## Submitting A Plugin[^1]
16
16
17
-
To submit a plugin to Millennium's plugin repository, open a pull request that adds your plugin as a submodule using the command
To submit a plugin, open a pull request that adds your repository as a submodule. From the root of this repository, run:
20
18
21
-
This will attach your repository from a specific commit, meaning when you update your repository, the changes won't be reflected here, unless you open a pull request to update it.
22
-
This is in place to prevent malicious code by forcing us to audit all of your code changes.
This pins your plugin at a specific commit. Updates to your repository won't appear here until you open a pull request to advance the pointer — this is intentional, as all code changes are audited before reaching users.
23
24
24
-
## Updating Your Plugin
25
+
## Updating Your Plugin[^2]
26
+
27
+
To update your plugin to a newer commit, pull from inside the submodule directory, then commit the pointer change in the parent repo:
25
28
26
-
Once you have your submodule added, in order to update it,
27
-
change directory to `plugins/your-plugin`, checkout the branch you wish to use and pull:
28
29
```
29
-
git checkout your-plugin-branch
30
-
git pull
30
+
git submodule update --remote plugins/your-plugin
31
+
git commit -m "chore: update your-plugin"
31
32
```
32
-
This should update your plugin to the latest version. Commit the change and open a pull request.
33
33
34
-
In case you wish to clone plugins at their attached commits, run `git submodule update --init`.
34
+
Then open a pull request with that commit.
35
+
36
+
To clone all plugins at their pinned commits after a fresh checkout, run `git submodule update --init`.
0 commit comments