Merge branch 'main' into copilot/fix-2609

Author: BernieWhite

.devcontainer/devcontainer.json

@@ -2,7 +2,7 @@
 // README at: https://github.com/devcontainers/templates/tree/main/src/dotnet
 {
   "name": "PSRule Developer",
-  "image": "mcr.microsoft.com/devcontainers/dotnet:1-8.0-noble",
+  "image": "mcr.microsoft.com/devcontainers/dotnet:8.0-noble",
   "customizations": {
     "vscode": {
       "settings": {
@@ -14,6 +14,7 @@
         }
       },
       "extensions": [
+        "ms-dotnettools.vscode-dotnet-runtime",
         "ms-dotnettools.csdevkit",
         "ms-vscode.powershell",
         "github.vscode-pull-request-github",
@@ -34,7 +35,7 @@
       "version": "latest"
     }
   },
-  "onCreateCommand": "dotnet tool install --global PowerShell --version 7.4.6 && sudo chown -R vscode:vscode /usr/bin/pwsh && sudo apt-get update -y && sudo apt-get upgrade -y && dotnet restore && pip install -r requirements-docs.txt && ln /usr/bin/pwsh /home/vscode/.dotnet/tools/pwsh --force",
+  "onCreateCommand": "sudo ./dotnet-install.sh --install-dir /usr/lib/dotnet && sudo dotnet workload update && dotnet tool install --global PowerShell --version 7.4.10 && sudo chown -R vscode:vscode /usr/bin/pwsh && sudo apt-get update -y && sudo apt-get upgrade -y && dotnet restore && pip install -r requirements-docs.txt && ln /usr/bin/pwsh /home/vscode/.dotnet/tools/pwsh --force",
   "updateContentCommand": "/usr/bin/pwsh -f .devcontainer/container-build.ps1",
   "postStartCommand": "/usr/bin/pwsh -f .devcontainer/container-start.ps1"
 }

.github/workflows/build.yaml

@@ -40,7 +40,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
+        uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5.0.0
         with:
           global-json-file: global.json
 
@@ -127,7 +127,7 @@ jobs:
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
+        uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5.0.0
         with:
           global-json-file: global.json
 
@@ -173,12 +173,12 @@ jobs:
           fetch-depth: 0
 
       - name: Setup node.js
-        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
           node-version: 20
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
+        uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5.0.0
         with:
           global-json-file: global.json
 
@@ -224,12 +224,12 @@ jobs:
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - name: Setup node.js
-        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
           node-version: 20
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
+        uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5.0.0
         with:
           global-json-file: global.json
 
@@ -264,7 +264,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Python
-        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
           python-version: '3.11'
           architecture: 'x64'
@@ -292,7 +292,7 @@ jobs:
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
+        uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5.0.0
         with:
           global-json-file: global.json
 
@@ -346,7 +346,7 @@ jobs:
           option: ps-rule-ci.yaml
 
       - name: Upload results to security tab
-        uses: github/codeql-action/upload-sarif@3c3833e0f8c1c83d449a7478aa59c036a9165498 # v3.29.5
+        uses: github/codeql-action/upload-sarif@f1f6e5f6af878fb37288ce1c627459e94dbf7d01 # v3.29.5
         if: always()
         with:
           sarif_file: reports/ps-rule-results.sarif
@@ -377,7 +377,7 @@ jobs:
           directory-to-scan: .
 
       - name: Upload results to security tab
-        uses: github/codeql-action/upload-sarif@3c3833e0f8c1c83d449a7478aa59c036a9165498 # v3.29.5
+        uses: github/codeql-action/upload-sarif@f1f6e5f6af878fb37288ce1c627459e94dbf7d01 # v3.29.5
         if: always()
         with:
           sarif_file: devskim-results.sarif
@@ -403,15 +403,15 @@ jobs:
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@3c3833e0f8c1c83d449a7478aa59c036a9165498 # v3.29.5
+        uses: github/codeql-action/init@f1f6e5f6af878fb37288ce1c627459e94dbf7d01 # v3.29.5
         with:
           languages: 'csharp'
 
       - name: Autobuild
-        uses: github/codeql-action/autobuild@3c3833e0f8c1c83d449a7478aa59c036a9165498 # v3.29.5
+        uses: github/codeql-action/autobuild@f1f6e5f6af878fb37288ce1c627459e94dbf7d01 # v3.29.5
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@3c3833e0f8c1c83d449a7478aa59c036a9165498 # v3.29.5
+        uses: github/codeql-action/analyze@f1f6e5f6af878fb37288ce1c627459e94dbf7d01 # v3.29.5
         id: codeql-analyze
 
       - name: Upload results

.github/workflows/copilot-setup-steps.yml

@@ -29,12 +29,12 @@ jobs:
           fetch-depth: 0
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
+        uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5.0.0
         with:
           global-json-file: global.json
 
       - name: Setup node.js
-        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
           node-version: 20
 

.github/workflows/docs.yaml

@@ -32,7 +32,7 @@ jobs:
           git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
 
       - name: Setup Python
-        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
           python-version: '3.11'
           architecture: 'x64'

.github/workflows/stale.yaml

@@ -21,7 +21,7 @@ jobs:
     permissions:
       issues: write
     steps:
-      - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
+      - uses: actions/stale@3a9db7e6a41a89f618792c92c0e97cc736e1b13f # v10.0.0
         with:
           stale-issue-message: >
             This issue has been automatically marked as stale because it has not had

docs/changelog.md

@@ -34,6 +34,12 @@ What's changed since pre-release v3.0.0-B0453:
   - Added support and by default error if rules or input is not found during a run by @BernieWhite.
     [#1778](https://github.com/microsoft/PSRule/issues/1778)
     - Added options for `Execution.NoMatchingRules`, `Execution.NoValidInput`, and `Execution.NoValidSources`.
+  - Added support for customizing CSV output columns by @BernieWhite.
+    [#1165](https://github.com/microsoft/PSRule/issues/1165)
+    - The `Output.CsvDetailedColumns` option can be used to customize the columns included in the CSV output format.
+- General improvements:
+  - Reload language server when options change by @BernieWhite.
+    [#2842](https://github.com/microsoft/PSRule/issues/2842)
 - Engineering:
   - **Important change**: Remove legacy log scopes by @BernieWhite.
     [#2891](https://github.com/microsoft/PSRule/issues/2891)

docs/concepts/PSRule/en-US/about_PSRule_Options.md

@@ -49,6 +49,7 @@ The following workspace options are available for use:
 - [Input.TargetType](#inputtargettype)
 - [Output.As](#outputas)
 - [Output.Banner](#outputbanner)
+- [Output.CsvDetailedColumns](#outputcsvdetailedcolumns)
 - [Output.Culture](#outputculture)
 - [Output.Encoding](#outputencoding)
 - [Output.Footer](#outputfooter)
@@ -2488,6 +2489,71 @@ variables:
   value: en-AU;en-US
 ```
 
+### Output.CsvDetailedColumns
+
+<!-- module:version 3.0.0 -->
+
+Configures which columns are included when using CSV detailed output format.
+This option allows you to customize the columns included in CSV output, reducing file size and focusing on relevant information.
+
+When this option is not specified, all default columns are included:
+`RuleName`, `TargetName`, `TargetType`, `Outcome`, `OutcomeReason`, `Synopsis`, `Recommendation`.
+
+When this option is specified, only the configured columns are included.
+The column order in the output matches the order specified in the configuration.
+
+Supported column types:
+
+- **Standard properties**: `RuleName`, `TargetName`, `TargetType`, `Outcome`, `OutcomeReason`, `Synopsis`, `Recommendation`
+- **Custom properties**: Properties under `Info.Annotations`, `Tag`, and `Field`
+
+Invalid column names result in empty values and do not cause errors.
+
+This option can be specified using:
+
+```powershell
+# PowerShell: Using the OutputCsvDetailedColumns parameter
+$option = New-PSRuleOption -OutputCsvDetailedColumns 'RuleName', 'TargetName', 'Outcome', 'Synopsis';
+```
+
+```powershell
+# PowerShell: Using the Output.CsvDetailedColumns hashtable key
+$option = New-PSRuleOption -Option @{ 'Output.CsvDetailedColumns' = 'RuleName', 'TargetName', 'Outcome', 'Synopsis' };
+```
+
+```powershell
+# PowerShell: Using the OutputCsvDetailedColumns parameter to set YAML
+Set-PSRuleOption -OutputCsvDetailedColumns 'RuleName', 'TargetName', 'Outcome', 'Synopsis';
+```
+
+```yaml
+# YAML: Using the output/csvDetailedColumns property
+output:
+  csvDetailedColumns:
+  - RuleName
+  - TargetName
+  - Outcome
+  - Synopsis
+```
+
+```bash
+# Bash: Using environment variable
+export PSRULE_OUTPUT_CSVDETAILEDCOLUMNS='RuleName;TargetName;Outcome;Synopsis'
+```
+
+```yaml
+# GitHub Actions: Using environment variable
+env:
+  PSRULE_OUTPUT_CSVDETAILEDCOLUMNS: 'RuleName;TargetName;Outcome;Synopsis'
+```
+
+```yaml
+# Azure Pipelines: Using environment variable
+variables:
+- name: PSRULE_OUTPUT_CSVDETAILEDCOLUMNS
+  value: 'RuleName;TargetName;Outcome;Synopsis'
+```
+
 ### Output.Encoding
 
 Configures the encoding used when output is written to file.
@@ -3641,6 +3707,11 @@ logging:
 output:
   as: Summary
   banner: Minimal
+  csvDetailedColumns:
+  - RuleName
+  - TargetName
+  - Outcome
+  - Synopsis
   culture:
   - en-US
   encoding: UTF8
@@ -3783,6 +3854,14 @@ logging:
 output:
   as: Detail
   banner: Default
+  csvDetailedColumns:
+    - RuleName
+    - TargetName
+    - TargetType
+    - Outcome
+    - OutcomeReason
+    - Synopsis
+    - Recommendation
   culture: [ ]
   encoding: Default
   footer: Default

docs/updates/v3.0.md

@@ -128,3 +128,6 @@ Continue reading [Formats and emitters](../concepts/formats.md) to learn more.
 
 - You can now override the options file that VSCode uses when running PSRule.
   - Previously only `ps-rule.yaml` was used by VSCode although PSRule generally supported changing the options file.
+- CSV output columns can be customized.
+  - Previously the CSV output format had a fixed set of columns.
+  - You can now customize the columns included in the CSV output through the `Output.CsvDetailedColumns` option.