OCram85/DroneHelper
OCram85/DroneHelper
Archived
1
0
Fork 0
Code Pull Requests Releases 3 Activity
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.
f5494e9eb2
DroneHelper/docs/Write-FailureStateFile.md
Marco Blessing 6a314eeb48
All checks were successful
continuous-integration/drone/push Build is passing
Details
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

1.1 KiB
Raw Blame History

external help file Module Name online version schema
ModuleRoot-help.xml DroneHelper 2.0.0

Write-FailureStateFile

SYNOPSIS

Writes the current pipeline step into failure log.

SYNTAX

Write-FailureStateFile [-StepName] <String> [<CommonParameters>]

DESCRIPTION

This Cmdlet is used to mark single steps as failed without stopping the complete pipeline.

EXAMPLES

EXAMPLE 1

Write-FailureStateFile

PARAMETERS

-StepName

The current DroneHelper step name which should be added into to the log.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
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.

INPUTS

[None] No pipeline input.

OUTPUTS

[None] No pipeline output.

NOTES

RELATED LINKS