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/config): add warning for deprecated options #28216

Conversation

RahulGautamSingh
Copy link
Collaborator

@RahulGautamSingh RahulGautamSingh commented Apr 3, 2024

Changes

  • Add two new fields deprecated and depreationMsg to RenovateOptionBase interface, and use them to display warning message for deprecated config options.
  • Add new function genDeprecationMsg similar to genExperimentalMsg

Context

#28104 (comment)

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 select 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

@RahulGautamSingh RahulGautamSingh changed the title docs: add warning for deprecated options docs(core/config): add warning for deprecated options Apr 3, 2024
@rarkins
Copy link
Collaborator

rarkins commented Apr 3, 2024

Cannot be done only with deprecationMsg?

secustor
secustor previously approved these changes Apr 3, 2024
lib/config/options/index.ts Outdated Show resolved Hide resolved
lib/config/options/index.ts Outdated Show resolved Hide resolved
lib/config/options/index.ts Outdated Show resolved Hide resolved
@RahulGautamSingh
Copy link
Collaborator Author

Before and After images of the docs after the changes:

branchName

image

commitMessage

image


prTitle

image

@secustor secustor added this pull request to the merge queue Apr 8, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 8, 2024
@secustor secustor added this pull request to the merge queue Apr 8, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 8, 2024
@viceice viceice added this pull request to the merge queue Apr 9, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 9, 2024
@secustor secustor added this pull request to the merge queue Apr 9, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 9, 2024
@rarkins rarkins added this pull request to the merge queue Apr 9, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 9, 2024
@secustor secustor added this pull request to the merge queue Apr 9, 2024
Merged via the queue into renovatebot:main with commit fe206f7 Apr 9, 2024
37 checks passed
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 37.280.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

6 participants