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

Release v2.0.0 #406

Merged
merged 1 commit into from
May 17, 2022
Merged

Release v2.0.0 #406

Show file tree
Hide file tree
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .azure-pipelines/loopback-pipeline.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ stages:
displayName: 'Extension'
steps:

- task: ps-rule-install@1
- task: ps-rule-install@2
displayName: Test install task
inputs:
module: PSRule.Rules.Azure

- task: ps-rule-assert@1
- task: ps-rule-assert@2
displayName: Test assert task
inputs:
outputFormat: NUnit3
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ See [upgrade notes][1] for helpful information when upgrading from previous vers

## Unreleased

## v2.0.0

What's changed since v1.5.0:

- New features:
Expand Down
9 changes: 2 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,14 @@ For example:
steps:

# Install PSRule.Rules.Azure from the PowerShell Gallery
- task: ps-rule-install@1
- task: ps-rule-install@2
inputs:
module: PSRule.Rules.Azure # Install PSRule.Rules.Azure from the PowerShell Gallery.
latest: false # Only install the module if not already installed.
prerelease: false # Install stable versions only.

# Run analysis from JSON files using the `PSRule.Rules.Azure` module and custom rules from `.ps-rule/`.
- task: ps-rule-assert@1
- task: ps-rule-assert@2
inputs:
inputType: inputPath
inputPath: 'out/*.json' # Read objects from JSON files in 'out/'.
modules: 'PSRule.Rules.Azure' # Analyze objects using the rules within the PSRule.Rules.Azure PowerShell module.
source: '.ps-rule/' # Additionally, analyze object using custom rules from '.ps-rule/'.
outputFormat: NUnit3 # Save results to an NUnit report.
outputPath: reports/ps-rule-results.xml # Write NUnit report to 'reports/ps-rule-results.xml'.

Expand Down
15 changes: 6 additions & 9 deletions docs/tasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Syntax:

```yaml
steps:
- task: ps-rule-install@1
- task: ps-rule-install@2
inputs:
module: string # Required. The name of a rule module to install.
latest: boolean # Optional. Determine if the installed module is updated to the latest version.
Expand All @@ -35,7 +35,7 @@ Install the latest stable version of `PSRule.Rules.Azure` from the PowerShell Ga

```yaml
steps:
- task: ps-rule-install@1
- task: ps-rule-install@2
inputs:
module: PSRule.Rules.Azure # Install PSRule.Rules.Azure from the PowerShell Gallery.
latest: false # Only install the module if not already installed.
Expand All @@ -51,7 +51,7 @@ Syntax:

```yaml
steps:
- task: ps-rule-assert@1
- task: ps-rule-assert@2
inputs:
inputType: repository, inputPath # Required. Determines the type of input to use for PSRule.
inputPath: string # Required. The path PSRule will look for files to validate.
Expand Down Expand Up @@ -117,7 +117,7 @@ Run analysis from JSON files using the `PSRule.Rules.Azure` module and custom ru

```yaml
steps:
- task: ps-rule-assert@1
- task: ps-rule-assert@2
inputs:
inputType: inputPath
inputPath: 'out/*.json' # Read objects from JSON files in 'out/'.
Expand All @@ -132,9 +132,8 @@ Results are outputted to a NUnit format that can be published using the publish

```yaml
steps:
- task: ps-rule-assert@1
- task: ps-rule-assert@2
inputs:
inputType: repository # Analyze repository structure.
inputPath: $(BUILD_SOURCESDIRECTORY) # Read repository structure from the default source path.
modules: 'PSRule.Rules.Azure' # Analyze objects using the rules within the PSRule.Rules.Azure PowerShell module.
outputFormat: NUnit3 # Save results to an NUnit report.
Expand All @@ -147,11 +146,9 @@ Run analysis of files within `out/` and all subdirectories using the named basel

```yaml
steps:
- task: ps-rule-assert@1
- task: ps-rule-assert@2
inputs:
inputType: inputPath
inputPath: 'out/' # Read objects from files in 'out/'.
modules: 'PSRule.Rules.Azure' # Analyze objects using the rules within the PSRule.Rules.Azure PowerShell module.
baseline: 'Azure.GA_2021_12' # Use the 'Azure.GA_2021_12' baseline included within PSRule.Rules.Azure.
source: '.ps-rule/' # Additionally, analyze object using custom rules from '.ps-rule/'.
```