OCram85/DroneHelper
OCram85/DroneHelper
Archived
1
0
Fork 0
Code Pull Requests Releases 3 Activity

update Readme
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/pr Build is passing
Details

Browse Source
This commit is contained in:
OCram85 2022-07-27 14:44:52 +02:00
parent e16908d4ce
commit 4295f48273
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -37,12 +37,26 @@
The DroneHelper PowerShell module adds several features for `Gitea -> Drone.IO` based build pipelines. It's designed 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: to perform all needed tasks for PowerShell Module development like:
- `FileLinter` -> Runs basic FileLinter tests with console and log file output ### Testing
- `Linter` -> Runs PSScriptAnalyzer with embedded to custom profiles.
- `UnitTest` -> Runs Pester tests including code coverage report with console and log file output. - `Invoke-FileLinter` -> Runs basic FileLinter tests with console and log file output
- `BuildReport` -> Takes all generated reports and reports them back as Pull Request Comment for a simplified overview. - `Invoke-Linter` -> Runs PSScriptAnalyzer with embedded to custom profiles.
- `StateReporter` -> Marks the current pipeline run / build as failed if the previous steps also raised errors. - `Invoke-UnitTest` -> Runs Pester tests including code coverage report with console and log file output.
- `DoksUpdater` -> Automatically updates the markdown based docs generated form your Comment Based Help blocks in your functions
### 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: To use these features, all you have to do, is follow the `.drone.yml` template: