Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixes #15874: Fix the check_variable_match documentation #1075

Merged
merged 1 commit into from
Nov 7, 2019
Merged

Fixes #15874: Fix the check_variable_match documentation #1075

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions tree/30_generic_methods/condition_from_variable_match.cf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@
# @documentation Test a variable content and create outcome classes depending on its value.
# This generic method will define a class `condition_from_variable_match_${condition_prefix}_{kept, repaired, error, reached}`.
#
# If the variable is found and its content matches the given regex, this will produce a kept outcome condition and a `${condition_prefix}_true` condition
# If the variable can not be found or if its content does not match the given regex, this will produce an error outcome condition and a `${condition_prefix}_false` condition
# * If the variable is found and its content matches the given regex, this will produce a kept outcome condition and a `${condition_prefix}_true` condition
# * If the variable is found but its content does not match the given regex, it will produce a kept outcome condition and a `${condition_prefix}_false` condition
# * If the variable can not be found, it will produce an error outcome condition and a `${condition_prefix}_false` condition
#
# /!\ Regex for unix machine must be PCRE compatible and those for Windows agent must respect the .Net regex format.
#
# @parameter condition_prefix Prefix of the class (condition) generated
# @parameter variable_name Complete name of the variable being tested, like my_prefix.my_variable
# @parameter expected_match Regex to use to test if the variable content is compliant
Expand Down