CFE-4681: document timer_policy attribute on classes: promises#3682
Merged
Conversation
nickanderson
force-pushed
the
CFE-4681/master
branch
2 times, most recently
from
c4ca509 to
0cbe104
Compare
Member
Author
|
Failing attribute check until cfengine/core#6174 is merged. |
olehermanse
previously requested changes
Jun 12, 2026
olehermanse
left a comment
olehermanse
left a comment
Member
There was a problem hiding this comment.
Changes look good but please don't merge until green in GH Actions.
2 tasks
Member
Author
|
@cf-bottom jenkins with cfengine/core#6174 please |
nickanderson
force-pushed
the
CFE-4681/master
branch
from
a9e7707 to
22060b5
Compare
Documents the timer_policy attribute on classes: promises (CFE-4681), which controls whether a persistent class restarts its timer when rediscovered. The default is reset on master (3.28.0); the attribute is also available on 3.24.5 and 3.27.2, where the default is absolute. Ticket: CFE-4681
cfengine dev format-docs now reformats cf3 code blocks (cfengine CLI 0.18.0), and expects a blank line between the classes: and insert_lines: promise types in the example. Add it so the Lint and format check passes.
nickanderson
force-pushed
the
CFE-4681/master
branch
from
22060b5 to
a26ef91
Compare
nickanderson
added a commit
that referenced
this pull request
Jul 8, 2026
cfengine CLI 0.18.0 ships a syntax-description.json that includes timer_policy on classes: promises, so the example no longer needs the {skip TODO} fence to pass cfengine dev lint-docs. Dropping it means the example is syntax-checked like the others. Follow-up to #3682 (merged with the fence).
nickanderson
added a commit
that referenced
this pull request
Jul 8, 2026
Unfence timer_policy example (follow-up to #3682)
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
timer_policyattribute onclasses:promises in the promise-type reference (CFE-4681).timer_policycontrols whether a persistent class restarts its timer when rediscovered:reset— re-evaluates the promise and restarts the timer, so the class keeps persisting while the policy runs and the expression stays true.absolute— preserves the original expiry; the promise is skipped while the class is already defined.This brings the
classes:promise type to parity with theclassesbody, which has long had atimer_policyattribute.Version-specific default
The new section documents the default as
reset(master → 3.28.0) and a History note records that the attribute is also available on 3.24.5 and 3.27.2, where the default isabsolute(preserving the historical behavior).Notes
### timer_policyincontent/reference/promise-types/classes.markdown, right after### persistence.[classes#persistence],[Promise types#timer_policy],[Promise types#persist_time]); no_references.mdchange needed.prettier --checkpasses; no inline.markdownlinks introduced.Related
absolute) and CFE-4681: default timer_policy => reset for classes: promises (3.28.0) core#6174 (default →resetfor 3.28.0)Once this looks right on master, it should be cherry-picked to the
3.24and3.27doc branches with the Default value and the History note adjusted toabsolutefor those streams.Merge with cfengine/core#6174