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

Update meta data to prepare v0.0.2 release #8

Merged
OCram85 merged 2 commits from prep002 into master 2022-07-27 14:48:49 +02:00
Conversation 1 Commits 2 Files Changed 2 +29 -6
2 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CHANGELOG.md
View File

@ -3,4 +3,13 @@
<!-- insertMark -->
## `v0.0.2`
- (e22fb0a) Fixes external dependencies in updated module manifest files (#7)
- (6a314ee) add platyPS generated docs (#5)
- (10182c5) fix module tags
- (175e770) update meta files (#4)
- (1f86741) adds assets (#3)
- (c2b2dc8) prepare release (#2)
## pre `v0.0.2`
- 🧙 Initial migrated version

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
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: