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/Send-PRComment.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

1.5 KiB

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

Send-PRComment

SYNOPSIS

Sends build report as Gitea PR comment.

SYNTAX

Send-PRComment [[-Mode] <String>] [[-GiteaUser] <String>] [<CommonParameters>]

DESCRIPTION

Send-PRComment is used to report the build details from drone.io pipeline.

EXAMPLES

EXAMPLE 1

Send-PRComment
Depends on Drone.IO injected environment vars. Doesn't work locally on dev systems.

PARAMETERS

-GiteaUser

Gitea user for drone bot

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: Drone-bot
Accept pipeline input: False
Accept wildcard characters: False

-Mode

Sets the report mode. Default is 'Renew'. This mode deletes the old pr comments and creates a new onw. Also available:

  • 'Add' -> simply adds new pr comments.
  • 'Edit' -> Edits the last known pr comment. Doesn't clean old ones.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: Renew
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].

OUTPUTS

[None]

NOTES