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/Readme.md
OCram85 85a86bec73
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
add platyPS generated docs
2022-07-14 11:17:57 +02:00

2.6 KiB

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.