CFE-4686: Document the classes promise cancel attribute#3683
Merged
nickanderson merged 2 commits intoJun 19, 2026
Merged
Conversation
Member
Author
|
@cf-bottom jenkins please |
|
Alright, I triggered a build: Jenkins: https://ci.cfengine.com/job/build-and-deploy-docs-master/5/ Packages: http://buildcache.cfengine.com/packages/testing-pr/jenkins-build-and-deploy-docs-master-5/ Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-build-and-deploy-docs-master-5/output/_site/ |
Added a reference section for the new 'cancel' attribute of classes promises, which undefines the promiser class when its class expression evaluates to true. Notes the evaluation-when-already-defined behaviour, hard-class protection, and mutual exclusion with the class-defining attributes. Ticket: CFE-4686 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
nickanderson
force-pushed
the
CFE-4686/classes-cancel-attribute
branch
from
0c35131 to
0271d22
Compare
Member
Author
|
@cf-bottom jenkins please |
craigcomstock
approved these changes
Jun 19, 2026
| `and`, `or`, `not`, `xor`, `dist`, `select_class`) — combining them is an | ||
| `Irreconcilable constraints` error — and also with the class-modifier | ||
| attributes (`persistence`, `scope`, `timer_policy`), which only affect how a | ||
| class is defined and are rejected alongside `cancel`. |
Contributor
There was a problem hiding this comment.
by "rejected" do you mean also causing an error to be logged?
Member
Author
There was a problem hiding this comment.
Yes, disallowed, mutually exclusive.
| `and`, `or`, `not`, `xor`, `dist`, `select_class`) — combining them is an | ||
| `Irreconcilable constraints` error — and also with the class-modifier | ||
| attributes (`persistence`, `scope`, `timer_policy`), which only affect how a | ||
| class is defined and are rejected alongside `cancel`. |
Contributor
There was a problem hiding this comment.
maybe ... "which only affect how a class is defined and will cause an error as well when combined with cancel."
Address Craig's review on PR cfengine#3683. Signed-off-by: Nick Anderson <nick@cmdln.org> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
3 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.
Summary
Documents the new
cancelattribute ofclassespromises (CFE-4686), whichundefines the promiser class when its class expression evaluates to true.
Adds a
### cancelreference section tocontent/reference/promise-types/classes.markdowncovering:expression)**History:**notes it as introduced in CFEngine 3.28.0 (not backported).Companion
Core implementation PR: cfengine/core#6175
Ticket: https://northerntech.atlassian.net/browse/CFE-4686
Verification
prettier --checkclean on the edited page..markdown-extension inline links introduced.[classes#expression],[Promise types#cancel_kept]) consistent with the existing page.🤖 Generated with Claude Code