Skip to content

GitHub Actions - Validate your plugin.json

License

Notifications You must be signed in to change notification settings

voxelite/plugin-json-validator

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Voxelite plugin.json Validator

GitHub Action to validate Voxelite's plugin.json (main information about the plugin).

Checks:

  • Presence of all required fields
  • Valid characters (especially for plugin's codename)
  • Impersonation prevention

Inputs

file

Required

Path to your plugin.json. Default "plugin.json" (=in root directory of your repository).

official

Set to true for official Voxelite plugins. Causes the validator to not check against official names.

Example usage

- name: plugin.json validation
  uses: voxelite/plugin-json-validator@v1

For plugin.json format look into official documentation, some examples can be found in test directory.

About

GitHub Actions - Validate your plugin.json

Resources

License

Stars

Watchers

Forks

Packages

No packages published