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/Get-RepoPath.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

59 lines
1.2 KiB
Markdown

---
external help file: ModuleRoot-help.xml
Module Name: DroneHelper
online version:
schema: 2.0.0
---
# Get-RepoPath
## SYNOPSIS
Updates the module manifest file fields to prepare the new build.
## SYNTAX
```
Get-RepoPath [[-SubPath] <String[]>] [<CommonParameters>]
```
## DESCRIPTION
Replaces the version fields in the manifest file.
Uses Drone env vars populated by pushed tags.
## EXAMPLES
### EXAMPLE 1
```
Import-Module -Name DroneHelper; Get-RepoPath
```
## PARAMETERS
### -SubPath
An optional string array of sub directories relative to the root.
```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
### [DroneHelper.Repo.Path] Returns a folder structured like object with relevant full paths.s
## NOTES
## RELATED LINKS