OCram85/DroneHelper
OCram85
/
DroneHelper
Archived
1
0
Fork 0
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
OCram85 6a314eeb48
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
..
Get-RepoPath.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Install-ModuleDependency.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Invoke-BuildState.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Invoke-FileLinter.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Invoke-InstallDependency.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Invoke-Linter.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Invoke-Publish.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Invoke-UnitTest.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Merge-ModuleRoot.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
New-BuildPackage.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
New-Docs.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Readme.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Send-PRComment.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Set-EOL.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Test-FileBOM.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Test-FileEOF.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Test-FileEOL.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Test-FileEncoding.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Test-FileTab.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Test-FileTailingWhitespace.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Update-Changelog.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Update-Docs.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Update-ModuleMeta.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Write-FailureStateFile.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00
Write-ResultFile.md add platyPS generated docs (#5) 2022-07-14 11:22:06 +02:00

Readme.md

Module Name Module Guid Download Help Link Help Version Locale
DroneHelper 4293292f-eac8-42ed-8e9d-437d4f405d2c
Update Download Link
Please enter version of help manually (X.X.X.X) format
en-US

DroneHelper Module

Description

See global Readme file for usage instructions.

DroneHelper Cmdlets

Get-RepoPath

Updates the module manifest file fields to prepare the new build.

Install-ModuleDependency

Install required modules of the module manifest file.

Invoke-BuildState

Sets final Drone pipeline build state.

Invoke-FileLinter

Runs the file linter for all src files found in current repository.

Invoke-InstallDependency

Install required modules for executing the DroneHelper pipeline helpers.

Invoke-Linter

Runs all PSScriptAnalyzer Rules within this repo.

Invoke-Publish

Publishes powershell module to internal Nexus repository.

Invoke-UnitTest

Runs all Pester tests within this repo.

Merge-ModuleRoot

Merges single ps1 files into one module script file.

New-BuildPackage

Creates a new module package as compressed archive.

New-Docs

Creates a ne set of markdown based help in the docs folder.

Send-PRComment

Sends build report as Gitea PR comment.

Set-EOL

Helper function to set the EOL sequence to LF or CRLF.

Test-FileBOM

Tests given file if native utf8 w/o BOM is used. Returns false if BOM is present.

Test-FileEncoding

Returns true if the given file is written in a valid encoding

Test-FileEOF

Returns false if EOF isn't an empty line.

Test-FileEOL

Returns false if EOL isn't CRLF

Test-FileTab

Returns false if tab char is used in file.

Test-FileTailingWhitespace

Returns false if there are any tailing whitespace in lines.

Update-Changelog

Updates the changelog file with recent commits

Update-Docs

Publishes powershell module to internal Nexus repository.

Update-ModuleMeta

Updates the module manifest file fields to prepare the new build.

Write-FailureStateFile

Writes the current pipeline step into failure log.

Write-ResultFile

Writes the current pipeline step into failure log.