CFE-4681: document timer_policy attribute on classes: promises (3.27)#3729
Open
nickanderson wants to merge 3 commits into
Open
CFE-4681: document timer_policy attribute on classes: promises (3.27)#3729nickanderson wants to merge 3 commits into
nickanderson wants to merge 3 commits into
Conversation
Documents the timer_policy attribute on classes: promises (CFE-4681), which controls whether a persistent class restarts its timer when rediscovered. On the 3.27 stream the default is absolute, preserving the historical behavior; the default changed to reset in 3.28.0. Ticket: CFE-4681
cfengine dev format-docs (cfengine CLI 0.18.0) now reformats cf3 code blocks inside markdown. Apply the reformatting branch-wide so the Lint and format GitHub Action passes. Mechanical change (whitespace/indentation inside cf3 examples); no prose or semantic changes.
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.
nickanderson
force-pushed
the
CFE-4681/3.27
branch
from
47f2866 to
f785cda
Compare
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
1 participant
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
Backports the
timer_policyattribute documentation onclasses:promises to the 3.27 stream (CFE-4681).Mirrors the master PR (#3682), with the Default value and History adjusted for this stream: on 3.27
timer_policydefaults toabsolute(the historical persistent-class behavior). The default changed toresetin 3.28.0.Contents
### timer_policytocontent/reference/promise-types/classes.markdown, right after### persistence. Cross-references use the auto-generated heading anchors ([classes#persistence],[Promise types#timer_policy],[Promise types#persist_time]); no_references.mdchange needed.cf3examples only; no prose or semantic changes), needed so theLint and formatcheck passes (see below).Why the reformat is included
The
Lint and formatworkflow installs the latest, unpinnedcfengineCLI. CLI 0.18.0 added cf3 code-block reformatting tocfengine dev format-docs.masterhad already been mass-reformatted, but the 3.27 branch had not, so ~129 files of pre-existing formatting drift would otherwise fail the check on any PR to 3.27 — unrelated to this change. The reformat resolves that.Verified locally with cfengine CLI 0.18.0:
cfengine format --check,cfengine dev format-docs(idempotent, cleangit diff), andcfengine dev lint-docsall pass.If you would rather keep the timer_policy change isolated, the reformat can be split into its own PR and this one rebased on top.
Related
absolute)