Renovate: Move JSON schema out of source control

[rarkins]

We need to decide where it should be “built” and where it should be published to.

docs.renovatebot.com is a good possibility

Should the build script be in the main Renovate repo or the docs one? If it’s in Renovate then we could generate the schema and then validate it as part of tests to make sure we never “break” it. Then the docs build script will execute it also and save the result to the web.

[viceice]

I would prefer it to build on docs. But we can use a simple jest snapshot test to validate on renovate repo.

So only the snapshot can be conflicted, but can easily updated.

[viceice]

we also see the snapshot diff on errors and on pr

[rarkins]

I’m aiming that people authoring need managers only need to update lib/manager/x though

[viceice]

Ok, maybe we can do a manual schema check, which makes sure we do not loose something. So only adding properties / objects is allowed.

[viceice]

I can do this with some magic jest Foo. 🤪

[JamieMagee]

Could we publish to JSON Schema store? And include the (non-standard) $schema property in the onboarding renovate.json?

[rarkins]

Can the publishing be automated?

[viceice]

Nice idea, we can add there a link to our schema. It must not live in their repo.

[viceice]

https://github.com/SchemaStore/schemastore/blob/master/src/api/json/catalog.json

See angular schema as example

[rarkins]

Yes but then shouldn’t the URL be on docs.renovatebot.com in future? Either that or a dedicated repo that we push to with Actions

[rarkins]

Another alternative:

• Keep the JSON schema in source control but no longer lint it
• Have a GitHub Action that runs after commits to master and commits an update to the JSON schema if necessary

[viceice]

Could be conflict if a master build is running and we merge another pr

[rarkins]

I think such a race condition should be extremely rare and also immediately recoverable because the second PR merging would result in a new action running and committing the right JSON schema (if updated).

[rarkins]

Here it is: https://docs.renovatebot.com/renovate-schema.json

[renovate-release]

:tada: This issue has been resolved in version 19.129.1 :tada:

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot :package::rocket: