File tree 1 file changed +13
-4
lines changed
1 file changed +13
-4
lines changed Original file line number Diff line number Diff line change 1
1
# Voxelite plugin.json Validator
2
2
3
- This action prints "Hello World" or "Hello" + the name of a person to greet to the log.
3
+ GitHub Action to validate [ Voxelite] ( https://github.com/voxelite ) 's ` plugin.json ` (main information about the plugin).
4
+
5
+ Checks:
6
+ - Presence of all required fields
7
+ - Valid characters (especially for plugin's codename)
8
+ - Impersonation prevention
4
9
5
10
## Inputs
6
11
7
12
### ` file `
8
13
9
- ** Required** Path to your ` plugin.json ` . Default ` "plugin.json" ` (=root directory of your repository).
14
+ ** Required**
15
+
16
+ Path to your ` plugin.json ` .
17
+ Default ` "plugin.json" ` (=in root directory of your repository).
10
18
11
19
### ` official `
12
20
@@ -16,7 +24,8 @@ Causes the validator to not check against official names.
16
24
## Example usage
17
25
18
26
``` yaml
19
- uses : voxelite/plugin-json-validator
27
+ - name : plugin.json validation
28
+ uses : voxelite/plugin-json-validator@v1
20
29
` ` `
21
30
22
- For ` plugin.json` format look into official documentation, some examples can be found in [test directory](test).
31
+ 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