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: preset-of-presets description is skipped in onboarding #31537

Merged
merged 2 commits into from
Sep 23, 2024

Conversation

jvmdc
Copy link
Contributor

@jvmdc jvmdc commented Sep 23, 2024

Changes

When a preset consisting only of presets is part of the onboarding configuration, its description is not included in the configuration summary. I could not find any documentation of this, so I have added this information to the configuration field.

The code of the behaviour being documented is here:

if (
presetKeys.length === 2 &&
presetKeys.includes('description') &&
presetKeys.includes('extends')
) {
// preset is just a collection of other presets
delete presetConfig.description;
}

Context

#31500

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

@rarkins rarkins enabled auto-merge September 23, 2024 09:06
@rarkins rarkins added this pull request to the merge queue Sep 23, 2024
Merged via the queue into renovatebot:main with commit c498560 Sep 23, 2024
38 checks passed
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 38.93.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

3 participants