docs: document that updateTypes: ['patch'] only works/matches if separateMinorPatch is set to true #7628
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I noticed that `updateTypes: ['patch']` only matches if `separateMinorPatch` is set to true. This comes somewhat unexpected and does not seem to be documented anywhere at the moment, as opposed to the documentation of the `patch` setting, where the docs correctly state `Only applies if separateMinorPatch is set to true`. Maybe related to renovatebot#2818 But without reading the docs, I would expect `updateTypes: ['patch']` to always match on patch updates (e.g. 1.0.0 to 1.0.1) regardless of the `separateMinorPatch` setting (which is only set if we want separate PRs or branches for patch AND minor updates)
casdevs
changed the title
casdevs
changed the title
viceice
previously approved these changes
Nov 2, 2020
|
Were the docs for this already updated? Cause I'm seeing this change live at https://docs.renovatebot.com/configuration-options/#patch EDIT: My mistake. I just search for this text on the docs site, saw it was there, but didn't realise it under |
JamieMagee
reviewed
Nov 4, 2020
docs/usage/configuration-options.md
Outdated
Comment on lines
1271
to
1276
| Update type `patch` only matches if `separateMinorPatch` is set to true. | ||
|
|
||
| ## patch | ||
|
|
||
| Add to this object if you wish to define rules that apply only to patch updates. | ||
| See also `major` and `minor` configuration options. | ||
| Only applies if `separateMinorPatch` is set to true. |
There was a problem hiding this comment.
You don't need to update definition.ts and configuration-options.md. The docs that get deployed are a combination of both. You can see by taking a look at the patch section online, which reads:
Configuration to apply when an update type is patch. Only applies if separateMinorPatch is set to true
rarkins
reviewed
Nov 4, 2020
rarkins
reviewed
Nov 4, 2020
rarkins
reviewed
Nov 4, 2020
JamieMagee
approved these changes
Nov 4, 2020
|
🎉 This PR is included in version 23.68.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
viceice
pushed a commit
that referenced
this pull request
Nov 4, 2020
…rateMinorPatch is set to true (#7628) Co-authored-by: Rhys Arkins <rhys@arkins.net> Co-authored-by: Jamie Magee <JamieMagee@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
update config definitions
Context:
I noticed that
updateTypes: ['patch']only matches patch updates ifseparateMinorPatchis set to true.This comes somewhat unexpected and does not seem to be documented anywhere at the moment, as opposed to the documentation of the
patchsetting, where the docs correctly stateOnly applies if separateMinorPatch is set to true.Maybe related to #2818
But without reading the docs, I would expect
updateTypes: ['patch']to always match on patch updates (e.g. 1.0.0 to 1.0.1) anyway, regardless of theseparateMinorPatchsetting (which is only set if we want separate PRs or branches for patch AND minor updates)Docs should be updated accordingly.
Documentation (please check one with an [x])
How I've tested my work (please tick one)
I have verified these changes via: