This repository has been archived on 2023-10-10. You can view files and clone it, but cannot push or open issues or pull requests.
DroneHelper/docs/New-BuildPackage.md
Marco Blessing 6a314eeb48
All checks were successful
continuous-integration/drone/push Build is passing
add platyPS generated docs (#5)
#### 📖 Summary

- Adds `platyPS` generated docs
- Converted CRLF output into LF
- linked global readme file in module page

#### 📑 Test Plan

> 💡 Select your test plan for the code changes.

- [x] Tested via Drone.io pipeline
- [ ] Custom test
- [ ] No test plan

##### Details / Justification

<!-- Add your test details or justification for missing tests here. -->

#### 📚 Additional Notes

<!-- A place for additional detail notes. -->

Co-authored-by: OCram85 <marco.blessing@googlemail.com>
Reviewed-on: #5
2022-07-14 11:22:06 +02:00

58 lines
1.2 KiB
Markdown

---
external help file: ModuleRoot-help.xml
Module Name: DroneHelper
online version:
schema: 2.0.0
---
# New-BuildPackage
## SYNOPSIS
Creates a new module package as compressed archive.
## SYNTAX
```
New-BuildPackage [[-AdditionalPath] <String[]>] [<CommonParameters>]
```
## DESCRIPTION
This function is used in build pipeline to create an uploadable module version for the Gitea release page.
## EXAMPLES
### EXAMPLE 1
```
Import-Module -Name DroneHelper; New-BuildPackage
```
## PARAMETERS
### -AdditionalPath
You can provide additional paths to add files or folders in published module.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
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).
## INPUTS
### [None] No pipeline input.
## OUTPUTS
### [None] No pipeline output.
## NOTES
## RELATED LINKS