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(core): add changelog renderOptions to nx-schema.json #23323

Closed
wants to merge 5 commits into from

Conversation

pkuczynski
Copy link
Contributor

Current Behavior

Schema does not have the documentation

Expected Behavior

Schema should list options from DefaultChangelogRenderOptions

@pkuczynski pkuczynski requested a review from a team as a code owner May 12, 2024 21:43
@pkuczynski pkuczynski requested a review from Cammisuli May 12, 2024 21:43
Copy link

vercel bot commented May 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview May 16, 2024 5:57pm

@pkuczynski pkuczynski changed the title fix(nx): add changelog renderOptions to nx-schema.json docs(core): add changelog renderOptions to nx-schema.json May 12, 2024
Based on `DefaultChangelogRenderOptions`

missing coma
@JamesHenry
Copy link
Collaborator

@pkuczynski The trouble with this is that the changelog renderer is swappable by design. There is no way in JSON schema (that I am aware of) to customize these values dynamically based on the value of the renderer property. If using a custom renderer there is no requirement for the options to be the same as these (again by design), so the schema would give incorrect feedback, which I think is worse than none given there is no way to override it.

For that reason I am going to close this one for now unless we can somehow can up with a reliable dynamic solution.

Many thanks!

@JamesHenry JamesHenry closed this May 21, 2024
Copy link

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants