Skip to content

Commit 9ca17a5

Browse files
MariusStorhaugMariusStorhaug
committed
🩹 [Patch]: Update settings table formatting in README.md for improved readability
1 parent 89a62e1 commit 9ca17a5

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

‎README.md‎

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -359,50 +359,50 @@ The file can be a `JSON`, `YAML`, or `PSD1` file. By default, it will look for `
359359

360360
The following settings are available in the settings file:
361361

362-
| Name | Type | Description | Default |
363-
| -------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------- | ------------------- |
364-
| `Name` | `String` | Name of the module to publish. Defaults to the repository name. | `null` |
365-
| `Test.Skip` | `Boolean` | Skip all tests | `false` |
366-
| `Test.Linux.Skip` | `Boolean` | Skip tests on Linux | `false` |
367-
| `Test.MacOS.Skip` | `Boolean` | Skip tests on macOS | `false` |
368-
| `Test.Windows.Skip` | `Boolean` | Skip tests on Windows | `false` |
369-
| `Test.SourceCode.Skip` | `Boolean` | Skip source code tests | `false` |
370-
| `Test.SourceCode.Linux.Skip` | `Boolean` | Skip source code tests on Linux | `false` |
371-
| `Test.SourceCode.MacOS.Skip` | `Boolean` | Skip source code tests on macOS | `false` |
372-
| `Test.SourceCode.Windows.Skip` | `Boolean` | Skip source code tests on Windows | `false` |
373-
| `Test.PSModule.Skip` | `Boolean` | Skip PSModule framework tests | `false` |
374-
| `Test.PSModule.Linux.Skip` | `Boolean` | Skip PSModule framework tests on Linux | `false` |
375-
| `Test.PSModule.MacOS.Skip` | `Boolean` | Skip PSModule framework tests on macOS | `false` |
376-
| `Test.PSModule.Windows.Skip` | `Boolean` | Skip PSModule framework tests on Windows | `false` |
377-
| `Test.Module.Skip` | `Boolean` | Skip module tests | `false` |
378-
| `Test.Module.Linux.Skip` | `Boolean` | Skip module tests on Linux | `false` |
379-
| `Test.Module.MacOS.Skip` | `Boolean` | Skip module tests on macOS | `false` |
380-
| `Test.Module.Windows.Skip` | `Boolean` | Skip module tests on Windows | `false` |
381-
| `Test.TestResults.Skip` | `Boolean` | Skip test result processing | `false` |
382-
| `Test.CodeCoverage.Skip` | `Boolean` | Skip code coverage tests | `false` |
383-
| `Test.CodeCoverage.PercentTarget` | `Integer` | Target code coverage percentage | `0` |
384-
| `Test.CodeCoverage.StepSummaryMode` | `String` | Step summary mode for code coverage reports | `'Missed, Files'` |
385-
| `Build.Skip` | `Boolean` | Skip all build tasks | `false` |
386-
| `Build.Module.Skip` | `Boolean` | Skip module build | `false` |
387-
| `Build.Docs.Skip` | `Boolean` | Skip documentation build | `false` |
388-
| `Build.Docs.ShowSummaryOnSuccess` | `Boolean` | Show super-linter summary on success for documentation linting | `false` |
389-
| `Build.Site.Skip` | `Boolean` | Skip site build | `false` |
390-
| `Publish.Module.Skip` | `Boolean` | Skip module publishing | `false` |
391-
| `Publish.Module.AutoCleanup` | `Boolean` | Automatically clean up old prerelease module versions | `true` |
392-
| `Publish.Module.AutoPatching` | `Boolean` | Automatically patch module version | `true` |
393-
| `Publish.Module.IncrementalPrerelease` | `Boolean` | Use incremental prerelease versioning | `true` |
394-
| `Publish.Module.DatePrereleaseFormat` | `String` | Format for date-based prerelease (uses [.NET DateTime format strings](https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings)) | `''` |
395-
| `Publish.Module.VersionPrefix` | `String` | Prefix for version tags | `'v'` |
396-
| `Publish.Module.MajorLabels` | `String` | Labels indicating a major version bump | `'major, breaking'` |
397-
| `Publish.Module.MinorLabels` | `String` | Labels indicating a minor version bump | `'minor, feature'` |
398-
| `Publish.Module.PatchLabels` | `String` | Labels indicating a patch version bump | `'patch, fix'` |
399-
| `Publish.Module.IgnoreLabels` | `String` | Labels indicating no release | `'NoRelease'` |
400-
| `Publish.Module.UsePRTitleAsReleaseName` | `Boolean` | Use the PR title as the GitHub release name instead of version string | `false` |
401-
| `Publish.Module.UsePRBodyAsReleaseNotes` | `Boolean` | Use the PR body as the release notes content | `true` |
402-
| `Publish.Module.UsePRTitleAsNotesHeading` | `Boolean` | Prepend PR title as H1 heading with PR number link before the body | `true` |
403-
| `Linter.Skip` | `Boolean` | Skip repository linting | `false` |
404-
| `Linter.ShowSummaryOnSuccess` | `Boolean` | Show super-linter summary on success for repository linting | `false` |
405-
| `Linter.env` | `Object` | Environment variables for super-linter configuration | `{}` |
362+
| Name | Type | Description | Default |
363+
| ----------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
364+
| `Name` | `String` | Name of the module to publish. Defaults to the repository name. | `null` |
365+
| `Test.Skip` | `Boolean` | Skip all tests | `false` |
366+
| `Test.Linux.Skip` | `Boolean` | Skip tests on Linux | `false` |
367+
| `Test.MacOS.Skip` | `Boolean` | Skip tests on macOS | `false` |
368+
| `Test.Windows.Skip` | `Boolean` | Skip tests on Windows | `false` |
369+
| `Test.SourceCode.Skip` | `Boolean` | Skip source code tests | `false` |
370+
| `Test.SourceCode.Linux.Skip` | `Boolean` | Skip source code tests on Linux | `false` |
371+
| `Test.SourceCode.MacOS.Skip` | `Boolean` | Skip source code tests on macOS | `false` |
372+
| `Test.SourceCode.Windows.Skip` | `Boolean` | Skip source code tests on Windows | `false` |
373+
| `Test.PSModule.Skip` | `Boolean` | Skip PSModule framework tests | `false` |
374+
| `Test.PSModule.Linux.Skip` | `Boolean` | Skip PSModule framework tests on Linux | `false` |
375+
| `Test.PSModule.MacOS.Skip` | `Boolean` | Skip PSModule framework tests on macOS | `false` |
376+
| `Test.PSModule.Windows.Skip` | `Boolean` | Skip PSModule framework tests on Windows | `false` |
377+
| `Test.Module.Skip` | `Boolean` | Skip module tests | `false` |
378+
| `Test.Module.Linux.Skip` | `Boolean` | Skip module tests on Linux | `false` |
379+
| `Test.Module.MacOS.Skip` | `Boolean` | Skip module tests on macOS | `false` |
380+
| `Test.Module.Windows.Skip` | `Boolean` | Skip module tests on Windows | `false` |
381+
| `Test.TestResults.Skip` | `Boolean` | Skip test result processing | `false` |
382+
| `Test.CodeCoverage.Skip` | `Boolean` | Skip code coverage tests | `false` |
383+
| `Test.CodeCoverage.PercentTarget` | `Integer` | Target code coverage percentage | `0` |
384+
| `Test.CodeCoverage.StepSummaryMode` | `String` | Step summary mode for code coverage reports | `'Missed, Files'` |
385+
| `Build.Skip` | `Boolean` | Skip all build tasks | `false` |
386+
| `Build.Module.Skip` | `Boolean` | Skip module build | `false` |
387+
| `Build.Docs.Skip` | `Boolean` | Skip documentation build | `false` |
388+
| `Build.Docs.ShowSummaryOnSuccess` | `Boolean` | Show super-linter summary on success for documentation linting | `false` |
389+
| `Build.Site.Skip` | `Boolean` | Skip site build | `false` |
390+
| `Publish.Module.Skip` | `Boolean` | Skip module publishing | `false` |
391+
| `Publish.Module.AutoCleanup` | `Boolean` | Automatically clean up old prerelease module versions | `true` |
392+
| `Publish.Module.AutoPatching` | `Boolean` | Automatically patch module version | `true` |
393+
| `Publish.Module.IncrementalPrerelease` | `Boolean` | Use incremental prerelease versioning | `true` |
394+
| `Publish.Module.DatePrereleaseFormat` | `String` | Format for date-based prerelease (uses [.NET DateTime format strings](https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings)) | `''` |
395+
| `Publish.Module.VersionPrefix` | `String` | Prefix for version tags | `'v'` |
396+
| `Publish.Module.MajorLabels` | `String` | Labels indicating a major version bump | `'major, breaking'` |
397+
| `Publish.Module.MinorLabels` | `String` | Labels indicating a minor version bump | `'minor, feature'` |
398+
| `Publish.Module.PatchLabels` | `String` | Labels indicating a patch version bump | `'patch, fix'` |
399+
| `Publish.Module.IgnoreLabels` | `String` | Labels indicating no release | `'NoRelease'` |
400+
| `Publish.Module.UsePRTitleAsReleaseName` | `Boolean` | Use the PR title as the GitHub release name instead of version string | `false` |
401+
| `Publish.Module.UsePRBodyAsReleaseNotes` | `Boolean` | Use the PR body as the release notes content | `true` |
402+
| `Publish.Module.UsePRTitleAsNotesHeading` | `Boolean` | Prepend PR title as H1 heading with PR number link before the body | `true` |
403+
| `Linter.Skip` | `Boolean` | Skip repository linting | `false` |
404+
| `Linter.ShowSummaryOnSuccess` | `Boolean` | Show super-linter summary on success for repository linting | `false` |
405+
| `Linter.env` | `Object` | Environment variables for super-linter configuration | `{}` |
406406

407407
<details>
408408
<summary>`PSModule.yml` with all defaults</summary>

0 commit comments

Comments
 (0)