Skip to content

Latest commit

 

History

History
320 lines (244 loc) · 15.1 KB

CHANGELOG-v1.md

File metadata and controls

320 lines (244 loc) · 15.1 KB
Raw

Change log

See upgrade notes for helpful information when upgrading from previous versions.

Important notes:

  • YAML resources will require an apiVersion from PSRule v2. #648

Unreleased

What's changed since v1.3.0:

  • General improvements:
    • PSRule banner can be configured in output when using Assert-PSRule. #708

v1.3.0

What's changed since v1.2.0:

  • Engine features:
  • General improvements:
    • Exclude .git sub-directory by default for recursive scans. #697
      • Added Input.IgnoreGitPath option to configure inclusion of .git path.
      • See about_PSRule_Options for details.
    • Added file path assertion helpers. #679
      • Added WithinPath to check the file path field is within a specified path.
      • Added NotWithinPath to check the file path field is not within a specified path
      • See about_PSRule_Assert for details.
    • Added DateTime type assertion helper. #680
      • Added IsDateTime to check of object field is [DateTime].
      • See about_PSRule_Assert for details.
    • Improved numeric comparison assertion helpers to compare [DateTime] fields. #685
      • Less, LessOrEqual, Greater, and GreaterOrEqual compare the number of days from the current time.
      • See about_PSRule_Assert for details.
    • Improved handling of field names for objects implementing IList, IEnumerable, and index properties. #692
  • Engineering:
    • Bump YamlDotNet from 8.1.2 to 11.1.1. #690
  • Bug fixes:
    • Fixed expected DocumentEnd got SequenceEnd. #698

What's changed since pre-release v1.3.0-B2105004:

  • No additional changes.

v1.3.0-B2105004 (pre-release)

What's changed since pre-release v1.3.0-B2104042:

  • Engine features:
  • General improvements:
    • Exclude .git sub-directory by default for recursive scans. #697
      • Added Input.IgnoreGitPath option to configure inclusion of .git path.
      • See about_PSRule_Options for details.

v1.3.0-B2104042 (pre-release)

What's changed since pre-release v1.3.0-B2104030:

  • Bug fixes:
    • Fixed expected DocumentEnd got SequenceEnd. #698

v1.3.0-B2104030 (pre-release)

What's changed since pre-release v1.3.0-B2104021:

  • General improvements:
    • Improved handling of field names for objects implementing IList, IEnumerable, and index properties. #692
  • Engineering:
    • Bump YamlDotNet from 8.1.2 to 11.1.1. #690

v1.3.0-B2104021 (pre-release)

What's changed since v1.2.0:

  • General improvements:
    • Added file path assertion helpers. #679
      • Added WithinPath to check the file path field is within a specified path.
      • Added NotWithinPath to check the file path field is not within a specified path
      • See about_PSRule_Assert for details.
    • Added DateTime type assertion helper. #680
      • Added IsDateTime to check of object field is [DateTime].
      • See about_PSRule_Assert for details.
    • Improved numeric comparison assertion helpers to compare [DateTime] fields. #685
      • Less, LessOrEqual, Greater, and GreaterOrEqual compare the number of days from the current time.
      • See about_PSRule_Assert for details.

v1.2.0

What's changed since v1.1.0:

  • Engine features:
    • Added support for extensibility with conventions. #650
      • Conventions provide an extensibility point within PSRule to execute actions within the pipeline.
      • A convention can expose Begin, Process, and End blocks.
      • In additional to within rules $PSRule.Data can be accessed from Begin and Process blocks.
      • See about_PSRule_Conventions for details.
    • Added support for object expansion with conventions. #661
      • Use the $PSRule.Import method to import child source objects into the pipeline.
      • See about_PSRule_Variables for details.
    • Added support for complex pre-conditions with selectors. #649
  • General improvements:
    • Added support for preferring automatic binding over custom binding configurations. #670
      • Added the Binding.PreferTargetInfo option to prefer target info specified by the object.
      • See about_PSRule_Options for details.
    • Added strong apiVersion to resource types. #647
      • Resource schemas now support an apiVersion field.
      • The apiVersion field is optional but recommended.
      • Resources without a apiVersion field will not be supported from PSRule v2.
      • Added warning to flag baseline without apiVersion set.
    • Added support for detecting files headers from additional file extensions using FileHeader. #664
      • Added .bicep, .csx, .jsx, .groovy, .java, .json, .jsonc, .scala, .rb, .bat, .cmd.
      • Added support for Jenkinsfile and Dockerfile without an extension.
      • See about_PSRule_Assert for details.
    • Added support for automatic type binding with files that do not have a file extension. #665
  • Bug fixes:
    • Fixed dependent rule execution is skipped for consequent input objects. #657

What's changed since pre-release v1.2.0-B2103043:

  • No additional changes.

v1.2.0-B2103043 (pre-release)

What's changed since pre-release v1.2.0-B2103031:

  • Engine features:
    • Added support for complex pre-conditions with selectors. #649
  • General improvements:
    • Added support for preferring automatic binding over custom binding configurations. #670
      • Added the Binding.PreferTargetInfo option to prefer target info specified by the object.
      • See about_PSRule_Options for details.
    • Added strong apiVersion to resource types. #647
      • Resource schemas now support an apiVersion field.
      • The apiVersion field is optional but recommended.
      • Resources without a apiVersion field will not be supported from PSRule v2.
      • Added warning to flag baseline without apiVersion set.

v1.2.0-B2103031 (pre-release)

What's changed since pre-release v1.2.0-B2103023:

  • General improvements:
    • Added support for detecting files headers from additional file extensions. #664
      • Added .bicep, .csx, .jsx, .groovy, .java, .json, .jsonc, .scala, .rb, .bat, .cmd.
      • Added support for Jenkinsfile and Dockerfile without an extension.
      • See about_PSRule_Assert for details.
    • Added support for automatic type binding with files that do not have a file extension. #665

v1.2.0-B2103023 (pre-release)

What's changed since pre-release v1.2.0-B2103016:

  • Engine features:
    • Added support for object expansion with conventions. #661
      • Use the $PSRule.Import method to import child source objects into the pipeline.
      • See about_PSRule_Variables for details.

v1.2.0-B2103016 (pre-release)

What's changed since pre-release v1.2.0-B2103008:

  • Bug fixes:
    • Fixed dependent rule execution is skipped for consequent input objects. #657

v1.2.0-B2103008 (pre-release)

What's changed since v1.1.0:

  • Engine features:
    • Added support for extensibility with conventions. #650
      • Conventions provide an extensibility point within PSRule to execute actions within the pipeline.
      • A convention can expose Begin, Process, and End blocks.
      • In additional to within rules $PSRule.Data can be accessed from Begin and Process blocks.
      • See about_PSRule_Conventions for details.

v1.1.0

What's changed since v1.0.3:

  • Engine features:
    • Added assertion helpers. #640
      • Added NotHasField to check object does not have any of the specified fields.
      • Added Null to check field value is null.
      • Added NotNull to check field value is not null.
      • See about_PSRule_Assert for details.
    • Added type assertion helpers. #635
      • Added IsNumeric to check field value is a numeric types.
      • Added IsInteger to check field value is an integer types.
      • Added IsBoolean to check field value is a boolean.
      • Added IsArray to check field value is an array.
      • Added IsString to check field value is a string.
      • Added TypeOf to check field value is a specified type.
      • See about_PSRule_Assert for details.
    • Added content helpers. #637
      • Added $PSRule.GetContentFirstOrDefault to get content and return the first object.
      • Added $PSRule.GetContentField to get the field from content objects.
      • See about_PSRule_Variables for details.
  • General improvements:
    • Updated HasJsonSchema assertion helper. #636
      • The URI scheme can optionally be ignored for http:// or https:// URIs.
      • The fragment # is ignored.
      • See about_PSRule_Assert for details.
    • Added support for -Outcome and -As to produce filtered output from Assert-PSRule. #643
      • Configure Output.As with Summary to produce summarized results per object.
      • Configure Output.Outcome to limit output to Fail or Error.
      • See Assert-PSRule for details.

What's changed since pre-release v1.1.0-B2102029:

  • No additional changes.

v1.1.0-B2102029 (pre-release)

What's changed since pre-release v1.1.0-B2102024:

  • General improvements:
    • Added support for -Outcome and -As to produce filtered output from Assert-PSRule. #643
      • Configure Output.As with Summary to produce summarized results per object.
      • Configure Output.Outcome to limit output to Fail or Error.
      • See Assert-PSRule for details.

v1.1.0-B2102024 (pre-release)

What's changed since pre-release v1.1.0-B2102019:

  • Engine features:
    • Added assertion helpers. #640
      • Added NotHasField to check object does not have any of the specified fields.
      • Added Null to check field value is null.
      • Added NotNull to check field value is not null.
      • See about_PSRule_Assert for details.

v1.1.0-B2102019 (pre-release)

What's changed since v1.0.3:

  • Engine features:
    • Added type assertion helpers. #635
      • Added IsNumeric to check field value is a numeric types.
      • Added IsInteger to check field value is an integer types.
      • Added IsBoolean to check field value is a boolean.
      • Added IsArray to check field value is an array.
      • Added IsString to check field value is a string.
      • Added TypeOf to check field value is a specified type.
      • See about_PSRule_Assert for details.
    • Added content helpers. #637
      • Added $PSRule.GetContentFirstOrDefault to get content and return the first object.
      • Added $PSRule.GetContentField to get the field from content objects.
      • See about_PSRule_Variables for details.
  • General improvements:
    • Updated HasJsonSchema assertion helper. #636
      • The URI scheme can optionally be ignored for http:// or https:// URIs.
      • The fragment # is ignored.
      • See about_PSRule_Assert for details.

v1.0.3

What's changed since v1.0.2:

  • Bug fixes:
    • Fixed reason reported fields for HasField and HasFields assertion helpers. #632

v1.0.2

What's changed since v1.0.1:

  • Engineering:
    • Bump Manatee.Json from 13.0.4 to 13.0.5. #619
  • Bug fixes:
    • Fixed GetContent processing of InputFileInfo. #625
    • Fixed null reference of rule reason with wide output. #626
    • Fixed markdown help handling of inline code blocks with [. #627
    • Fixed markdown help inclusion of fenced code blocks in notes and description. #628

v1.0.1

What's changed since v1.0.0:

  • Bug fixes:
    • Fixed module source key has already been added. #608

v1.0.0

What's changed since v0.22.0:

  • General improvements:
    • Added rule help link in failed Assert-PSRule output. #595
  • Engineering:
    • Breaking change: Removed deprecated $Rule properties. #495
    • Bump Manatee.Json from 13.0.3 to 13.0.4. #591

What's changed since pre-release v1.0.0-B2011028:

  • No additional changes.

v1.0.0-B2011028 (pre-release)

What's changed since v0.22.0:

  • General improvements:
    • Added rule help link in failed Assert-PSRule output. #595
  • Engineering:
    • Breaking change: Removed deprecated $Rule properties. #495
    • Bump Manatee.Json from 13.0.3 to 13.0.4. #591