This project provides you with a template that uses Oxygen Scripting Validation tool, and allows you to validate the files from your GitHub repository. The Validation Script starts whenever a commit is pushed to your repo, and generates a validation report that is available on GitHub Pages platform.

To get things ready, follow these steps:

1. Create a new GitHub project using this template. This allows you to easily create a new repository without copying and pasting the content, and with no history or reference to this repository. All you have to do is click the Use this template button. Make sure to check Include all branches option.
2. Get an Oxygen Scripting license key from https://www.oxygenxml.com/xml_scripting/pricing.html (you can also request a trial). Add it as a secret to your repository (Settings → Secrets and variables → Actions → New repository secret), and name it "SCRIPTING_LICENSE_KEY".
3. Open build/gradle.properties file and replace "oxygenxml" with your GitHub {userid}.

Now, as the setup should be ready, you can simply add your files inside the validation directory and push them into your repository. This will trigger the validation workflow, that by default validates the entire directory. The validation report will be deployed to gh-pages branch. Feel free to use or remove the sample files provided with this template.

📝 Make sure the workflow has read/write permissions (Settings → Actions → General → Workflow permissions). Otherwise, you may not be able to deploy your report.

If you want to validate only the files in a specific directory, you need to run the process manually by following these steps:

• In your GitHub repository, click on Actions tab.
• Select Run Validation Script from the left panel.
• Click the Run workflow button in the right side.
• Type the name of the directory and click Run workflow.

👀 If you already have a repository that you want to perform validation on, you may want to check Oxygen Validation action and include it in your workflow.

The validation report generated using Oxygen Scripting should be available here: https://{userid}.github.io/{reponame}/validationReport.html

The validation report generated from oxygenxml repository is available here: https://oxygenxml.github.io/oxygen-script-validation-template/validationReport.html