Provide information on how to run validators locally

[tillig]

Context

As people create new content for Developer Studio, there is a need to perform validation locally before attempting a pull request. The PR process for Developer Studio content is challenging already, so having the ability to pre-check things before starting that would be helpful.

Solution

Provide instructions on how to run validation locally, outside of a GitHub build environment.

This may involve things like...

• Packaging validators up as actual npm style packages instead of nesting them with the custom build tasks.
• Breaking down the custom build task repo remote-actions into a properly versioned set of individual build task repos that can be composed independently into other build pipelines.
• Providing documentation on how to clone the validation repo and execute the pipeline against a known location (e.g., developer-studio-validate ./location/of/my/repo)

This may be related to #924 in that the README for the remote-actions repo needs a lot of improvement.

Alternatives

None.

Additional Context

Given the challenge in getting access to these repos in public GitHub and educating developers in the proper way of composing Developer Studio PRs, we actually have a whole separate repository where we store our content (not the xd-preview repo, but something in Azure DevOps) and we have automation that pushes changes we make through the Developer Studio process. We have our own review and approval process that doesn't work when forced to use Yet Another Git Location where not everyone has access. As such, the ability to potentially integrate the Developer Studio tooling into our own pre-validation process is huge, such that we can check things in our PR process before we get hit with problems down the road.

Some of the challenge here may be addressed by improving the way content gets into Developer Studio - some sort of API to push pre-generated content that adheres to a standard rather than assuming a specific source repo and build location/environment would go a long way to adding flexibility we need while still getting Developer Studio the content required.

Region

No response

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[tillig]

Not stale.