🪲 [Fix]: Fix issues with docs#30
Conversation
…d description and example
There was a problem hiding this comment.
Pull Request Overview
This PR fixes documentation and CI/CD configuration issues by enhancing PowerShell function documentation and adding linter controls to the GitHub Actions workflow.
- Enhanced the
Test-Admin.ps1function documentation with a proper description and formatted code example - Added linter configuration section to disable various validation checks in the CI/CD pipeline
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/functions/public/Test-Admin.ps1 | Added description section and formatted code example block |
| .github/PSModule.yml | Added linter environment variables to control validation steps |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| .EXAMPLE | ||
| Test-Role | ||
| ```pwsh | ||
| Test-Admin |
There was a problem hiding this comment.
The example section should include the expected output to make it more helpful for users. Consider adding a line showing what the function returns, such as '$true' or '$false'.
| Test-Admin | |
| Test-Admin | |
| # Output (if running as Administrator/root) | |
| $true |
Marius Storhaug (MariusStorhaug)
temporarily deployed
to
github-pages
GitHub Actions
Inactive
|
Module Admin - 1.1.11 published to the PowerShell Gallery. |
|
GitHub release for Admin v1.1.11 has been created. |
Description
This pull request introduces improvements to documentation and configuration for testing and linting. The main changes are an enhancement to the
Test-Admin.ps1function documentation and the addition of linter environment variable controls in the GitHub Actions workflow.Documentation improvements:
.DESCRIPTIONand.EXAMPLEsections in theTest-Admin.ps1function to clarify its purpose and usage, including a code example.CI/CD configuration:
Lintersection to.github/PSModule.ymlwith environment variables to control various validation steps, allowing selective enabling/disabling of linting and formatting checks.