Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Show-ContainerTools to add flag -ToolName #55

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

TinaMor
Copy link
Contributor

@TinaMor TinaMor commented Feb 6, 2025

PR description

What does this PR do

  • Refactor Show-ContainerTools to reuse functions and rewrite the unit tests
  • Allow user to get tool info for only one tool using flag -ToolName

Additional tasks

  • Bug fixes
  • Spelling issues in comments and documentation

Testing information

> Get-Help Show-ContainerTools
    ...
    SYNTAX
        Show-ContainerTools [-Latest] [-ToolName] [<CommonParameters>]
    ...
> Show-ContainerTools -Latest -ToolName buildkit

    For unregistered services/daemons, check the tool's help or register the service using
            Register-BuildkitdService, Register-ContainerdService, Start-BuildkitdService, Start-ContainerdService, Stop-BuildkitdService, Stop-ContainerdService

    Tool          : buildkit
    Path          : C:\Program Files\Buildkit\bin\buildkitd.exe
    Installed     : True
    Version       : v0.19.0
    Daemon        : buildkitd
    DaemonStatus  : Unregistered
    BuildctlPath  : C:\Program Files\Buildkit\bin\buildctl.exe
    LatestVersion : v0.19.0

Checklist

As part of our commitment to engineering excellence, before submitting this PR, please make sure:

  • You've tested this code in both Desktop & Server environments and AMD & ARM64 enviroments (functional testing).
  • You've added unit tests for new code.
  • You've added/updated documentation in the cmdlet docs, command-reference.md and the modules help files.
  • You've reviewed the PR/code best practices defined in the CONTRIBUTING.md.

In addition, after this PR has been reviewed, please agree to:

  • If changes have been made to your PR in the process of addressing comments, please make sure to test again the final version in both AMD and ARM64 environments.
  • Validate your changes have not introduced any regressions.

@TinaMor TinaMor changed the title Refactor Show-ContainerTools Refactor Show-ContainerTools to add flag -ToolName Feb 6, 2025
    - Refactor Show-ContainerTools to reuse functions and rewrite the unit tests
    - Bug fixes
    - Spelling issues and omit words (param names or variable names) from spellchecker
@TinaMor TinaMor force-pushed the tinamor/refactor-Show-ContainerTools branch from 2603330 to ae5123e Compare February 6, 2025 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant