From b4e03be180897a792c88b6e96688a0bccc6a60b0 Mon Sep 17 00:00:00 2001 From: Marco Blessing Date: Wed, 27 Jul 2022 14:48:48 +0200 Subject: [PATCH] Update meta data to prepare v0.0.2 release (#8) #### :book: Summary - update changelog - update readme #### :bookmark_tabs: Test Plan > :bulb: Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification #### :books: Additional Notes Co-authored-by: OCram85 Reviewed-on: https://gitea.ocram85.com/OCram85/DroneHelper/pulls/8 --- CHANGELOG.md | 9 +++++++++ README.md | 26 ++++++++++++++++++++------ 2 files changed, 29 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 85a3cd4..7583447 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,4 +3,13 @@ ## `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 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: