From 4295f48273a9893d7347021e4d71d6a33740840a Mon Sep 17 00:00:00 2001 From: OCram85 Date: Wed, 27 Jul 2022 14:44:52 +0200 Subject: [PATCH] update Readme --- README.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index cb14667..17f4096 100644 --- a/README.md +++ b/README.md @@ -37,12 +37,26 @@ The DroneHelper PowerShell module adds several features for `Gitea -> Drone.IO` based build pipelines. It's designed to perform all needed tasks for PowerShell Module development like: -- `FileLinter` -> Runs basic FileLinter tests with console and log file output -- `Linter` -> Runs PSScriptAnalyzer with embedded to custom profiles. -- `UnitTest` -> Runs Pester tests including code coverage report with console and log file output. -- `BuildReport` -> Takes all generated reports and reports them back as Pull Request Comment for a simplified overview. -- `StateReporter` -> Marks the current pipeline run / build as failed if the previous steps also raised errors. -- `DoksUpdater` -> Automatically updates the markdown based docs generated form your Comment Based Help blocks in your functions +### Testing + +- `Invoke-FileLinter` -> Runs basic FileLinter tests with console and log file output +- `Invoke-Linter` -> Runs PSScriptAnalyzer with embedded to custom profiles. +- `Invoke-UnitTest` -> Runs Pester tests including code coverage report with console and log file output. + +### Build Pipeline +- `Send-PRComment` -> Takes all generated reports and reports them back as Pull Request Comment for a simplified overview. +- `Write-FailureStateFile`, `Invoke-Build` -> Marks the current pipeline run / build as failed if the previous steps also raised errors. + +### Helper + +- `New-Docs`, `Update-Docs` -> Automatically updates the markdown based docs generated form your Comment Based Help blocks in your functions + + +### Building & Publishing + +- `Update-ModuleMeta` -> Updates the `ModuleVersion` + `Prerelease` properties wit the current git tag. +- `Merge-ModuleRoot` -> Takes all single file functions and merges them into a single `*.psm1` file. +- `New-BuildPackage` -> Creates a new build artifact for an alternate publishing target like a Gitea release. To use these features, all you have to do, is follow the `.drone.yml` template: