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

feat: add renovate-schema.json to published package #17235

Merged
merged 5 commits into from Aug 18, 2022

Conversation

robertkowalski
Copy link
Contributor

Changes

this change includes the renovate-schema.json in the published package

Context

tools like vscode have great support for including a "$schema"
property in your json for code completion and validation.

usually that $schema prop points to
https://docs.renovatebot.com/renovate-schema.json but this is
always the latest version of renovate.

in self-hosted environments not always the latest version is used,
so this patch adds the schema file to the bundled package for
easier reuse.

closes #13835

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

tools like vscode have great support for includeing a `"$schema"`
property in your json for code completion and validation.

usually that `$schema` prop points to
`https://docs.renovatebot.com/renovate-schema.json` but this is
always the *latest* version of renovate.

in self-hosted environments not always the latest version is used,
so this patch adds the schema file to the bundled package for
easier reuse.

closes renovatebot#13835
Copy link
Member

@viceice viceice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add create-json-schema to build command only and revert other changes

package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@rarkins rarkins requested a review from viceice August 18, 2022 07:10
@viceice viceice enabled auto-merge (squash) August 18, 2022 08:30
@viceice viceice merged commit 139b46b into renovatebot:main Aug 18, 2022
@robertkowalski robertkowalski deleted the renovate-schema branch August 18, 2022 08:59
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 32.164.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 18, 2022
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.

Provide packaged renovate-schema.json
4 participants