File tree 1 file changed +13
-3
lines changed
1 file changed +13
-3
lines changed Original file line number Diff line number Diff line change 1
1
# Voxelite plugin.json Validator
2
2
3
- GitHub Action to validate [ Voxelite] ( https://github.com/ voxelite ) 's ` plugin.json ` (main information about the plugin).
3
+ GitHub Action to validate [ Voxelite] ( https://voxelite.net ) 's ` plugin.json ` (main information about the plugin).
4
4
5
5
Checks:
6
6
- Presence of all required fields
7
7
- Valid characters (especially for plugin's codename)
8
- - Impersonation prevention
8
+ - Voxelite impersonation prevention
9
9
10
10
## Inputs
11
11
@@ -14,18 +14,28 @@ Checks:
14
14
** Required**
15
15
16
16
Path to your ` plugin.json ` .
17
- Default ` "plugin.json" ` (= in root directory of your repository) .
17
+ Default ` "plugin.json" ` in current directory.
18
18
19
19
### ` official `
20
20
21
21
Set to ` true ` for official Voxelite plugins.
22
22
Causes the validator to not check against official names.
23
23
24
+ Do not use this unless you are an official plugin.
25
+ It does not give you any advantage, just ignores checks for official-sounding names.
26
+
24
27
## Example usage
25
28
26
29
``` yaml
27
30
- name : plugin.json validation
28
31
uses : voxelite/plugin-json-validator@v1
29
32
` ` `
30
33
34
+ ` ` ` yaml
35
+ - name : plugin.json validation
36
+ uses : voxelite/plugin-json-validator@v1
37
+ with :
38
+ file : path/to/plugin.json
39
+ ` ` `
40
+
31
41
For ` plugin.json` format look into official documentation, some examples can be found in [test directory](test).
You can’t perform that action at this time.
0 commit comments