Add config option: optional-extends. #665
Merged
Conversation
This file contains hidden or 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
This is the same as the `extends` option, but then for optional files. The names must be file paths, not URLs. If the path does not exist, it is silently ignored. This is useful for optionally loading a `local.cfg` or `custom.cfg` with options specific for the developer or the server. I have seen various ways of having local options without checking this into version control: * Let git ignore `buildout.cfg` and have a sample `buildout.cfg.in` that you copy to `buildout.cfg` and adapt for the machine. * Have a `local.cfg` that extends `buildout.cfg` or an alternative like `devel.cfg` or `production.cfg`. * Let `buildout.cfg` extend `custom.cfg` which is not in version control, so you get an error when you don't yet have this file. When this PR is merged, I intend to use this in the Plone core development buildout.
8aa75f4 to
0075582
Compare
icemac
approved these changes
Sep 25, 2024
Good point. I now print a message when not found, regardless of verbosity: It would usually be the first line that is printed. This seems a useful hint for anyone using a Buildout with optional-extends. |
|
Good idea ! Thanks for working on this ! |
|
Thanks for the reviews. I have released 3.2.0 with this. |
mauritsvanrees
added a commit
to plone/buildout.coredev
that referenced
this pull request
Sep 26, 2024
I added this option in buildout/buildout#665 For inspiration, here is part of my own `local.cfg`: ``` [buildout] develop += /Users/maurits/community/zest.releaser auto-checkout += plone.releaser custom-eggs += pdbpp allow-picked-versions = true [remotes] plone = [email protected]:plone collective = [email protected]:collective zope = [email protected]:zopefoundation [versions] zest.releaser = ``` Originally the file started with these lines: ``` [buildout] extends = buildout.cfg ``` and then I always ran `bin/buildout -c local.cfg`. When I then wanted to use `plips/plip-distributions.cfg`, it got tricky because this was in a different directory, so I needed actual changes in git. Now it works in both cases thanks to the `optional-extends`.
mauritsvanrees
added a commit
to plone/buildout.coredev
that referenced
this pull request
Oct 1, 2024
I added this option in buildout/buildout#665 For inspiration, here is part of my own `local.cfg`: ``` [buildout] develop += /Users/maurits/community/zest.releaser auto-checkout += plone.releaser custom-eggs += pdbpp allow-picked-versions = true [remotes] plone = [email protected]:plone collective = [email protected]:collective zope = [email protected]:zopefoundation [versions] zest.releaser = ``` Originally the file started with these lines: ``` [buildout] extends = buildout.cfg ``` and then I always ran `bin/buildout -c local.cfg`. When I then wanted to use `plips/plip-distributions.cfg`, it got tricky because this was in a different directory, so I needed actual changes in git. Now it works in both cases thanks to the `optional-extends`.
|
I just saw this in the pypi release notes. I've been using a workaround for this for a few years now; optional-extends is a great idea. Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This is the same as the
extendsoption, but then for optional files. The names must be file paths, not URLs. If the path does not exist, it is silently ignored.This is useful for optionally loading a
local.cfgorcustom.cfgwith options specific for the developer or the server.I have seen various ways of having local options without checking this into version control:
buildout.cfgand have a samplebuildout.cfg.inthat you copy tobuildout.cfgand adapt for the machine.local.cfgthat extendsbuildout.cfgor an alternative likedevel.cfgorproduction.cfg.buildout.cfgextendcustom.cfgwhich is not in version control, so you get an error when you don't yet have this file.When this PR is merged, I intend to use this in the Plone core development buildout.