[Feature]: Add Testing Capability to Validate Site Metadata

[chrisreddington]

Provide a general summary of the suggestion

Based on recent experience, it can be quite a temperamental experience (i.e. to output the appropriate Hugo variables in the correct way for escaping strings for example).

To prevent against this, it is important to have a more thorough testing as part of the PR process.

Context

One of the great features of the theme is that it has a strong focus on SEO. However, as new features are introduced, contributors will need to update the site metadata templates.

Possible Implementation

• Run hugo --minify with an example --baseURL in the GitHub Action. If there is a rendering issue, it will be caught there.
• Could complete some linting on the build output
• Could check that outputted URLs on the build output's JSON are well-formed.

Your Environment

No response

[chrisreddington]

https://applitools.com/blog/automated-testing-seo-data/

[chrisreddington]

Connected to CloudWithChris/cloudwithchris.com#1183. Will be able to re-use tests from there on the exampleSite implementation within this repo.

[chrisreddington]

This has been completed in CloudWithChris/cloudwithchris.com.

Can port over retrospectively if needed, but closing this issue for now, as no known users using the theme :)