Open VictorIreri opened 1 year ago
Related to #4162
Also, some IDEs automatically source and apply the latest schema (1.22.0) regardless of the detekt version in the project which may lead to confusion.
Probably a feature request for detekt/detekt-intellij-plugin...
All supported versions of detekt should have their schemas uploaded to the JSON Schema Store
We only support the latest version, so in a way we're already do this :)
Instead of going back to populate old versions we could instead make updating this part of the release process and make sure all future releases are versioned.
Do we even publish those? I think that right now we are not doing it.
It's current as there is a schema for 1.22 already available. I'm saying we should update and version the schema with each new release from now on but not go back and provide older schemas, just to limit the scope of work.
I'm saying we should update and version the schema with each new release from now on but not go back and provide older schemas, just to limit the scope of work.
Agree. If we hook this in the release workflow I can take care of it 👍
This issue is stale because it has been open 90 days with no activity. Please comment or this will be closed in 7 days.
Context
The JSON schema URL, specified in configurations.md, is now versioned and the docs were recently updated for the latest version in https://github.com/detekt/detekt/pull/5881. However, only the latest JSON schema (1.22.0) is available in the Schema Store.
Expected behaviour
detekt.yml
, but I haven't explored this further. See the comment from @TWiStErRob: https://github.com/detekt/detekt/issues/4162#issuecomment-13318783011.21.1
&1.22.1
to update the broken JSON Schema URLs in the versioned website docs is worthwhile or, if possible, the change is trivial enough to update the existing versions. v1.21.0 https://github.com/detekt/detekt/blob/f081ebe6f99d9069a3a7aa43e354c4aff4a7bc59/website/versioned_docs/version-1.21.0/introduction/configurations.md?plain=1#L165 v1.22.0 https://github.com/detekt/detekt/blob/f081ebe6f99d9069a3a7aa43e354c4aff4a7bc59/website/versioned_docs/version-1.22.0/introduction/configurations.md?plain=1#L182main
branch https://github.com/detekt/detekt/blob/f081ebe6f99d9069a3a7aa43e354c4aff4a7bc59/website/docs/introduction/configurations.md?plain=1#L182Actual behaviour
Users on detekt versions prior to
1.22.0
are not informed of where to get the JSON schema from since the schemas don't exist in the Schema Store. Also, some IDEs automatically source and apply the latest schema (1.22.0) regardless of the detekt version in the project which may lead to confusion.