Skip to content

Commit 23662a3

Browse files
HeyItsGilbertHeyItsGilbert
committed
chore: 🔄 Add TaskDependencies to table
* Improved alignment and consistency of task tables. * Enhanced readability of dependencies and descriptions.
1 parent 2babf9a commit 23662a3

File tree

1 file changed

+29
-18
lines changed

1 file changed

+29
-18
lines changed

‎README.md‎

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PowerShellBuild
22

3-
| GitHub Actions | PS Gallery | License |
4-
|----------------|------------|---------|
3+
| GitHub Actions | PS Gallery | License |
4+
|-------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|--------------------------------------|
55
| [![GitHub Actions Status][github-actions-badge]][github-actions-build] [![GitHub Actions Status][github-actions-badge-publish]][github-actions-build] | [![PowerShell Gallery][psgallery-badge]][psgallery] | [![License][license-badge]][license] |
66

77
This project aims to provide common [psake](https://github.com/psake/psake) and
@@ -53,28 +53,28 @@ other projects.
5353
These primary tasks are the main tasks you'll typically call as part of
5454
PowerShell module development.
5555

56-
| Name | Dependencies | Description |
57-
| --------------------- | --------------------- | ----------- |
58-
| Init | _none_ | Initialize psake and task variables |
59-
| Clean | init | Clean output directory |
60-
| Build | StageFiles, BuildHelp | Clean and build module in output directory |
61-
| Analyze | Build | Run PSScriptAnalyzer tests |
62-
| Pester | Build | Run Pester tests |
63-
| Test | Analyze, Pester | Run combined tests |
64-
| Publish | Test | Publish module to defined PowerShell repository |
56+
| Name | Dependencies | Description |
57+
|---------|-----------------------|-------------------------------------------------|
58+
| Init | _none_ | Initialize psake and task variables |
59+
| Clean | init | Clean output directory |
60+
| Build | StageFiles, BuildHelp | Clean and build module in output directory |
61+
| Analyze | Build | Run PSScriptAnalyzer tests |
62+
| Pester | Build | Run Pester tests |
63+
| Test | Analyze, Pester | Run combined tests |
64+
| Publish | Test | Publish module to defined PowerShell repository |
6565

6666
### Secondary Tasks
6767

6868
These secondary tasks are called as dependencies from the primary tasks but may
6969
also be called directly.
7070

71-
| Name | Dependencies | Description |
72-
| --------------------- | -------------------------------| ----------- |
73-
| BuildHelp | GenerateMarkdown, GenerateMAML | Build all help files |
71+
| Name | Dependencies | Description |
72+
|-----------------------|--------------------------------|----------------------------------|
73+
| BuildHelp | GenerateMarkdown, GenerateMAML | Build all help files |
7474
| StageFiles | Clean | Build module in output directory |
75-
| GenerateMarkdown | StageFiles | Build markdown-based help |
76-
| GenerateMAML | GenerateMarkdown | Build MAML help |
77-
| GenerateUpdatableHelp | BuildHelp | Build updatable help cab |
75+
| GenerateMarkdown | StageFiles | Build markdown-based help |
76+
| GenerateMAML | GenerateMarkdown | Build MAML help |
77+
| GenerateUpdatableHelp | BuildHelp | Build updatable help cab |
7878

7979
## Task customization
8080

@@ -119,10 +119,21 @@ match your environment.
119119
| $PSBPreference.Help.DefaultLocale | `(Get-UICulture).Name` | Default locale used for help generation |
120120
| $PSBPreference.Help.ConvertReadMeToAboutHelp | `$false` | Convert project readme into the module about file |
121121
| $PSBPreference.Docs.RootDir | `$projectRoot/docs` | Directory PlatyPS markdown documentation will be saved to |
122-
| $PSBPreference.Docs.Overwrite | `$false` | Overwrite the markdown files in the docs folder using the comment based help as the source of truth. |
122+
| $PSBPreference.Docs.Overwrite | `$false` | Overwrite the markdown files in the docs folder using the comment based help as the source of truth. |
123123
| $PSBPreference.Publish.PSRepository | `PSGallery` | PowerShell repository name to publish |
124124
| $PSBPreference.Publish.PSRepositoryApiKey | `$env:PSGALLERY_API_KEY` | API key to authenticate to PowerShell repository with |
125125
| $PSBPreference.Publish.PSRepositoryCredential | `$null` | Credential to authenticate to PowerShell repository with. Overrides `$psRepositoryApiKey` if defined |
126+
| $PSBPreference.TaskDependencies.Clean | 'Init' | Tasks the 'Clean' task depends on. |
127+
| $PSBPreference.TaskDependencies.StageFiles | 'Clean' | Tasks the 'StageFiles' task depends on. |
128+
| $PSBPreference.TaskDependencies.Build | 'StageFiles', 'BuildHelp' | Tasks the 'Build' task depends on. |
129+
| $PSBPreference.TaskDependencies.Analyze | 'Build' | Tasks the 'Analyze' task depends on. |
130+
| $PSBPreference.TaskDependencies.Pester | 'Build' | Tasks the 'Pester' task depends on. |
131+
| $PSBPreference.TaskDependencies.Test | 'Pester', 'Analyze' | Tasks the 'Test' task depends on. |
132+
| $PSBPreference.TaskDependencies.BuildHelp | 'GenerateMarkdown', 'GenerateMAML' | Tasks the 'BuildHelp' task depends on. |
133+
| $PSBPreference.TaskDependencies.GenerateMarkdown | 'StageFiles' | Tasks the 'GenerateMarkdown' task depends on. |
134+
| $PSBPreference.TaskDependencies.GenerateMAML | 'GenerateMarkdown' | Tasks the 'GenerateMAML' task depends on. |
135+
| $PSBPreference.TaskDependencies.GenerateUpdatableHelp | 'BuildHelp' | Tasks the 'GenerateUpdatableHelp' task depends on. |
136+
| $PSBPreference.TaskDependencies.Publish | 'Test' | Tasks the 'Publish' task depends on. |
126137

127138
## Examples
128139

0 commit comments

Comments
 (0)