Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PrzemyslawKlys committed Nov 1, 2023
1 parent 2c534d0 commit c3a91b3
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 2 deletions.
36 changes: 35 additions & 1 deletion Docs/New-ConfigurationArtefact.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ New-ConfigurationArtefact [[-PostScriptMerge] <ScriptBlock>] [[-PreScriptMerge]
[-Enable] [-IncludeTagName] [-Path <String>] [-AddRequiredModules] [-ModulesPath <String>]
[-RequiredModulesPath <String>] [-CopyDirectories <IDictionary>] [-CopyFiles <IDictionary>]
[-CopyDirectoriesRelative] [-CopyFilesRelative] [-DoNotClear] [-ArtefactName <String>] [-ScriptName <String>]
[-ID <String>] [<CommonParameters>]
[-ID <String>] [-PostScriptMergePath <String>] [-PreScriptMergePath <String>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -59,6 +59,7 @@ New-ConfigurationArtefact -Type ScriptPacked -Enable -Path "$PSScriptRoot\..\Art
### -PostScriptMerge
ScriptBlock that will be added in the end of the script.
It's only applicable to type of Script, PackedScript.
If useed with PostScriptMergePath, this will be ignored.

```yaml
Type: ScriptBlock
Expand All @@ -75,6 +76,7 @@ Accept wildcard characters: False
### -PreScriptMerge
ScriptBlock that will be added in the beggining of the script.
It's only applicable to type of Script, PackedScript.
If useed with PreScriptMergePath, this will be ignored.
```yaml
Type: ScriptBlock
Expand Down Expand Up @@ -371,6 +373,38 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -PostScriptMergePath
Path to file that will be added in the end of the script.
It's only applicable to type of Script, PackedScript.
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -PreScriptMergePath
Path to file that will be added in the beggining of the script.
It's only applicable to type of Script, PackedScript.
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
19 changes: 18 additions & 1 deletion Docs/New-ConfigurationBuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ New-ConfigurationBuild [-Enable] [-DeleteTargetModuleBeforeBuild] [-MergeModuleO
[-DoNotAttemptToFixRelativePaths] [-MergeLibraryDebugging] [-ResolveBinaryConflicts]
[[-ResolveBinaryConflictsName] <String>] [[-CertificateThumbprint] <String>] [[-CertificatePFXPath] <String>]
[[-CertificatePFXBase64] <String>] [[-CertificatePFXPassword] <String>] [[-NETConfiguration] <String>]
[[-NETFramework] <String[]>] [[-NETProjectName] <String>] [<CommonParameters>]
[[-NETFramework] <String[]>] [[-NETProjectName] <String>] [-NETExcludeMainLibrary] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -369,6 +369,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -NETExcludeMainLibrary
Exclude main library from build, this is useful if you have C# project that you want to build
that is used mostly for generating libraries that are used in PowerShell module
It won't include main library in the build, but it will include all other libraries
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down

0 comments on commit c3a91b3

Please sign in to comment.