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: Add sub-preset examples to the tables in Presets #28256

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

TWiStErRob
Copy link
Contributor

Changes

Added sub-preset examples to the tables in Presets in this page: https://docs.renovatebot.com/config-presets/

Context

The syntax is trivial only in hind-sight, it took me a while to figure them out. I had to read the source code to find this magical line which confirmed that this is supported:

const [fileName, presetName, subPresetName] = filePreset.split('/');

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

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.

we don't like to document, because those are deprecated

@TWiStErRob
Copy link
Contributor Author

Oh, ok. 3 questions then:

@viceice
Copy link
Member

viceice commented Apr 9, 2024

subpresets are soft deprecated, so intentionally not documented.

use path based presets

@HonkingGoose
Copy link
Collaborator

@TWiStErRob You should subscribe to this PR:

Maybe we're dropping the table you're editing in this PR. The maintainers haven't decided yet, but wanted to give a warning about it anyways. 😉

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

Successfully merging this pull request may close these issues.

None yet

3 participants