Skip to content

Deprecated guest_environments and defaults#3610

Merged
olehermanse merged 1 commit intocfengine:masterfrom
olehermanse:deprecated
Mar 20, 2026
Merged

Deprecated guest_environments and defaults#3610
olehermanse merged 1 commit intocfengine:masterfrom
olehermanse:deprecated

Conversation

@olehermanse
Copy link
Member

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.

@olehermanse olehermanse changed the title Deprecated to guest_environments and defaults Deprecated guest_environments and defaults Mar 20, 2026
@olehermanse olehermanse marked this pull request as ready for review March 20, 2026 13:23
@olehermanse
Copy link
Member Author

@cf-bottom jenkins, please :)

@cf-bottom
Copy link

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>
@olehermanse
Copy link
Member Author

@cf-bottom try jenkins again please :)

@cf-bottom
Copy link

@olehermanse olehermanse merged commit d48dea9 into cfengine:master Mar 20, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants