Deprecated guest_environments and defaults#3610
Merged
olehermanse merged 1 commit intocfengine:masterfrom Mar 20, 2026
Merged
Conversation
Member
Author
|
@cf-bottom jenkins, please :) |
|
Alright, I triggered a build: Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/8/ Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-8/output/_site/ |
CFEngine is not compiled with guest_environments by default, so this promise type is not available in most installations. It also hasn't been updated in a long time, so we decided it's better to mark it as deprecated. The defaults promise type is still possible to use, but seems to not be widely used, nor encouraged. You can achieve similar functionality through the use of conditionally setting variables, often by using isvariable() function, and also by having default values in augments files (def.json). Thus, since we don't use defaults ourselves, and encourage users to use normal variables and/or augments instead, it makes sense to mark it as deprecated in docs to discourage its use. Signed-off-by: Ole Herman Schumacher Elgesem <ole@northern.tech>
Member
Author
|
@cf-bottom try jenkins again please :) |
|
Sure, I triggered a build: Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/9/ Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-9/output/_site/ |
larsewi
approved these changes
Mar 20, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
CFEngine is not compiled with guest_environments by default,
so this promise type is not available in most installations.
It also hasn't been updated in a long time, so we decided
it's better to mark it as deprecated.
The defaults promise type is still possible to use, but
seems to not be widely used, nor encouraged. You can achieve
similar functionality through the use of conditionally
setting variables, often by using isvariable() function, and
also by having default values in augments files (def.json).
Thus, since we don't use defaults ourselves, and encourage
users to use normal variables and/or augments instead, it
makes sense to mark it as deprecated in docs to discourage its
use.