Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Programmatically update JSON schema URL #5894

Closed
VictorIreri opened this issue Mar 12, 2023 · 5 comments
Closed

Docs: Programmatically update JSON schema URL #5894

VictorIreri opened this issue Mar 12, 2023 · 5 comments
Labels

Comments

@VictorIreri
Copy link

VictorIreri commented Mar 12, 2023

Context

The JSON schema URL, specified in configurations.md, is now versioned. The docs were recently updated in #5881.

Expected Behavior

The URL should be programmatically updated when a new version of detekt is being prepared as part of PRs like this #5544. This would reduce the chance of it being forgotten and becoming out of date.

However, it's worth bearing in mind that the schema itself is not automatically generated as specified here:

The JSON Schema is currently not automatically generated. It can be updated manually [on this repository](https://github.com/SchemaStore/schemastore).

Current Behavior

The URL is manually updated.

@cortinico
Copy link
Member

Essentially a duplicate of #4162 if I'm not mistaken

@VictorIreri
Copy link
Author

VictorIreri commented Mar 15, 2023

Hey @cortinico! I think this issue is purely about updating the Schema Store URL in the docs programmatically when we release a new detekt version and can be done in isolation. But maybe it would make more sense to tackle it only when the schema itself is being auto-generated as per the issue you linked. 🤔 Happy to close this if so.

@cortinico
Copy link
Member

Yeah in general we need all the pipeline to generate & publish the json schema for each version

@schalkms
Copy link
Member

schalkms commented Apr 2, 2023

@cortinico shall we keep this (duplicated) issue open, then?
I'm doing a bit of housekeeping right now, hence the question.

@cortinico
Copy link
Member

@cortinico shall we keep this (duplicated) issue open, then? I'm doing a bit of housekeeping right now, hence the question.

Nope we can close this. We'll keep #4162 to take care of all the JSON Schema related work

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants