Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 0 additions & 7 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,6 @@ jobs:
- name: Validate installer
run: wix.exe msi validate -sice ICE61 ps-nlog.msi

- name: Upload doc artifacts
uses: actions/upload-artifact@v7
with:
name: docs
path: ./docs/
if-no-files-found: error

- name: Upload msi artifacts
uses: actions/upload-artifact@v7
with:
Expand Down
13 changes: 9 additions & 4 deletions docs/PSNLog/Add-NLogLoggingConfiguration.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
---
document type: cmdlet
external help file: PSNLog.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: PSNLog
ms.date: 05-17-2026
ms.date: 06-13-2026
PlatyPS schema version: 2024-05-01
title: Add-NLogLoggingConfiguration
---
Expand All @@ -24,6 +24,11 @@ Add-NLogLoggingConfiguration [-Configuration] <LoggingConfiguration> [-PassThru]
[<CommonParameters>]
```

## ALIASES

None.


## DESCRIPTION

The Add-NLogLoggingConfiguration cmdlet adds the specified configuration instance to the static `NLog.LogManager.Configuration` property.
Expand Down Expand Up @@ -104,13 +109,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### NLog.Config.LoggingConfiguration

You can pipe an **NLog.Config.LoggingConfiguration** object to this cmdlet.
You can pipe the configuration to apply.

## OUTPUTS

### NLog.Config.LoggingConfiguration

When you use the **PassThru** parameter, this cmdlet returns the **NLog.Config.LoggingConfiguration** object. Otherwise, this cmdlet does not generate any output.
Returns the applied logging configuration when you use the **PassThru** parameter. Otherwise, this cmdlet does not generate any output.

## NOTES

Expand Down
19 changes: 12 additions & 7 deletions docs/PSNLog/Add-NLogLoggingRule.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
---
document type: cmdlet
external help file: PSNLog.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: PSNLog
ms.date: 05-17-2026
ms.date: 06-13-2026
PlatyPS schema version: 2024-05-01
title: Add-NLogLoggingRule
---
Expand All @@ -24,6 +24,11 @@ Add-NLogLoggingRule [-Rule] <LoggingRule> [-Configuration] <LoggingConfiguration
[<CommonParameters>]
```

## ALIASES

None.


## DESCRIPTION

The Add-NLogLoggingRule cmdlet adds the specified logging rule to the existing collection of rules in the specified configuration.
Expand Down Expand Up @@ -121,19 +126,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

### NLog.Config.LoggingRule
### NLog.Config.LoggingConfiguration

You can pipe an **NLog.Config.LoggingRule** object to this cmdlet.
You can pipe the configuration to update.

### NLog.Config.LoggingConfiguration
### NLog.Config.LoggingRule

You can pipe an **NLog.Config.LoggingConfiguration** object to this cmdlet.
You can pipe the rule to add.

## OUTPUTS

### NLog.Config.LoggingConfiguration

When you use the **PassThru** parameter, this cmdlet returns the **NLog.Config.LoggingConfiguration** object. Otherwise, this cmdlet does not generate any output.
Returns the updated logging configuration when you use the **PassThru** parameter. Otherwise, this cmdlet does not generate any output.

## NOTES

Expand Down
19 changes: 12 additions & 7 deletions docs/PSNLog/Add-NLogTarget.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
---
document type: cmdlet
external help file: PSNLog.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: PSNLog
ms.date: 05-17-2026
ms.date: 06-13-2026
PlatyPS schema version: 2024-05-01
title: Add-NLogTarget
---
Expand All @@ -24,6 +24,11 @@ Add-NLogTarget [-Target] <Target> [-Configuration] <LoggingConfiguration> [-Pass
[<CommonParameters>]
```

## ALIASES

None.


## DESCRIPTION

The Add-NLogTarget cmdlet adds the specified logging target to the existing collection of targets in the specified configuration.
Expand Down Expand Up @@ -114,19 +119,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

### NLog.Targets.Target
### NLog.Config.LoggingConfiguration

You can pipe an **NLog.Targets.Target** object to this cmdlet.
You can pipe the configuration to update.

### NLog.Config.LoggingConfiguration
### NLog.Targets.Target

You can pipe an **NLog.Config.LoggingConfiguration** object to this cmdlet.
You can pipe the target to add.

## OUTPUTS

### NLog.Config.LoggingConfiguration

When you use the **PassThru** parameter, this cmdlet returns the **NLog.Config.LoggingConfiguration** object. Otherwise, this cmdlet does not generate any output.
Returns the updated logging configuration when you use the **PassThru** parameter. Otherwise, this cmdlet does not generate any output.

## NOTES

Expand Down
13 changes: 9 additions & 4 deletions docs/PSNLog/Get-NLogLogger.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
---
document type: cmdlet
external help file: PSNLog.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: PSNLog
ms.date: 05-17-2026
ms.date: 06-13-2026
PlatyPS schema version: 2024-05-01
title: Get-NLogLogger
---
Expand All @@ -23,6 +23,11 @@ Gets a named logger.
Get-NLogLogger [-Name] <string> [<CommonParameters>]
```

## ALIASES

None.


## DESCRIPTION

The Get-NLogLogger cmdlet gets a named logger from the current configuration.
Expand Down Expand Up @@ -81,13 +86,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### System.String

You can pipe the logger name to this cmdlet.
You can pipe the logger name.

## OUTPUTS

### NLog.Logger

This cmdlet returns an **NLog.Logger** object.
Returns the logger with the specified name.

## NOTES

Expand Down
11 changes: 8 additions & 3 deletions docs/PSNLog/Get-NLogLoggingConfiguration.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
---
document type: cmdlet
external help file: PSNLog.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: PSNLog
ms.date: 05-17-2026
ms.date: 06-13-2026
PlatyPS schema version: 2024-05-01
title: Get-NLogLoggingConfiguration
---
Expand All @@ -23,6 +23,11 @@ Gets the current logging configuration.
Get-NLogLoggingConfiguration [<CommonParameters>]
```

## ALIASES

None.


## DESCRIPTION

The Get-NLogLoggingConfiguration cmdlet gets the current configuration.
Expand Down Expand Up @@ -54,7 +59,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### NLog.Config.LoggingConfiguration

This cmdlet returns the **NLog.Config.LoggingConfiguration** object from the static `NLog.LogManager.Configuration` property.
Returns the current logging configuration from `NLog.LogManager.Configuration`.

## NOTES

Expand Down
17 changes: 13 additions & 4 deletions docs/PSNLog/New-NLogBasicLogger.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
---
document type: cmdlet
external help file: PSNLog.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: PSNLog
ms.date: 05-17-2026
ms.date: 06-13-2026
PlatyPS schema version: 2024-05-01
title: New-NLogBasicLogger
---
Expand All @@ -23,6 +23,11 @@ Creates a basic logger with a common configuration.
New-NLogBasicLogger [-Name] <string> [-Path] <string> [<CommonParameters>]
```

## ALIASES

None.


## DESCRIPTION

The New-NLogBasicLogger cmdlet creates a basic logger with a common configuration.
Expand Down Expand Up @@ -99,13 +104,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### System.String

You can pipe a string to this cmdlet.
You can pipe objects with a Name property that specifies the logger name.

### System.String

You can pipe objects with a Path property that specifies the log file path.

## OUTPUTS

### NLog.Config.LoggingConfiguration

This cmdlet returns an **NLog.Config.LoggingConfiguration** object.
Returns a new logging configuration for a basic file logger.

## NOTES

Expand Down
Loading
Loading