A Project Griffon Validation Plugin is a single function with the intent to validate one thing and one thing only. The Project Griffon UI loads validations into an iFrame and collects results for each function. Validations have access to a set of global APIs to simplify writing functions.
This project contains validations owned by some Adobe organizations.
View the wiki to learn more about validations and how to get started
Each directory found in the plugins directory is packaged and uploaded to Project Griffon.
This project leverages the Project Griffon Plugin Tools to package and upload each directory.
Alternatively, validations can be uploaded Using the Validation Editor.
Validations are required to contain a manifest file at the root level named plugin.json.
In the Validation Editor view, this file is auto-generated.
A manifest file should contain the following metadata:
Path to the validation script.
A display name for your validation.
A unique namespace.
Indicates the type of plugin. The value should be validation.
Needs to follow a version described by the semver specification.
Brief description that explains what the validation does.
For grouping validation results in views.
To upload validations from the command line using the Project Griffon Plugin Tools, you need to have an IMS account and set the following environment variables:
IMS Username export IMS_USERNAME=XXXXX
IMS Password export IMS_PASSWORD=XXXXX
Client Secret export CLIENT_SECRET=XXXXX
IMS Organization ID export IMS_ORG=XXXXX
Then package the plugin as a zip folder.
yarn build
Next run the uploader. If you're updating the validation, be sure to update the version in your plugin.json manifest file.
yarn upload
Optionally, a plugin argument can be provided to build or upload a single plugin.
yarn upload -- --plugin=adobe-analytics-compatible-version
Contributions are welcomed! Read the Contributing Guide for more information.
This project is licensed under the Apache V2 License. See LICENSE for more information.