update Readme
This commit is contained in:
parent
e16908d4ce
commit
4295f48273
26
README.md
26
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:
|
||||
|
||||
|
Reference in New Issue
Block a user