Skip to content

Commit

Permalink
Add doc updates (microsoft#2658)
Browse files Browse the repository at this point in the history
  • Loading branch information
BernieWhite authored Dec 6, 2024
1 parent 7f3dc1f commit d34a734
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion docs/updates/v3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,30 @@ version: 3.0

# nnn nnn (v3.0)

For a detailed change log see [v3](../CHANGELOG-v3.md).
Welcome to the nnn nnn release of PSRule.
There are many updates in this version that we hope you'll like, some of the key highlights include:

- [Official CLI support](#official-cli-support) — A new CLI experience for PSRule.
- [Module lock file](#module-lock-file) — Manage the versions of modules used by PSRule.
- [Runtime integration](#runtime-integration) — More seamless integration with Visual Studio Code.

See the detailed change log [here](../CHANGELOG-v3.md).

## Official CLI support

While many of you have been using PSRule through PowerShell for some time,
we've been working on a new experience for those who prefer a CLI.

Additionally we wanted to improve the bootstrapping experience for PSRule in CI/CD pipelines.

The new CLI runs on Windows, macOS, and Linux and is available as a standalone executable or can be installed as a .NET tool.

## Module lock file

We've introduced a new feature to help you manage the versions of modules used by PSRule.
The module lock file is a JSON-based file named `ps-rule.lock.json` that lists the modules and versions used by PSRule.

This makes it easier to share and reproduce the versions of modules used during development and CI/CD pipelines.

## Visual Studio Code

Expand All @@ -29,6 +52,12 @@ a prerequisite step was to install PowerShell on non-Windows OSs and then instal

We've done away with this approach entirely for the authoring experience in VSCode by providing native support in the extension.

This means you can now use PSRule in VSCode without needing to install PowerShell or PSRule on your machine.
We've improved the experience by adding the ability to:

- Restore modules from the VSCode command palette.
- Asking to automatically restore required modules when you open a workspace that contains a PSRule lock file.

### Other minor features and improvements

- You can now override the options file that VSCode uses when running PSRule.
Expand Down

0 comments on commit d34a734

Please sign in to comment.