🚀 [Feature]: Add functions to manage Artifacts

[MariusStorhaug]

Description

This pull request introduces several enhancements and new features related to handling GitHub Actions artifacts, including a new PowerShell class and functions to manage artifacts.

Enhancements to Artifact Management:

• Artifact class and format:

  • Added GitHubArtifact class to represent GitHub Actions artifacts with properties like DatabaseID, NodeID, Name, Owner, Repository, Size, Url, ArchiveDownloadUrl, Expired, Digest, CreatedAt, UpdatedAt, ExpiresAt, and WorkflowRun.
  • Added GitHubArtifact.Format.ps1xml to define a table view for displaying artifact properties in a structured format.

• New public function for artifact management:

  • Get-GitHubArtifact: Retrieve GitHub Artifacts based on repo, workflow run or id.
  • Remove-GitHubArtifact: Removes a GitHub Artifact. Accepts a GitHub Artifact object via pipeline.
  • Save-GitHubArtifact: Downloads GitHub Artifacts by ID. Accepts a GitHub Artifact object via pipeline.

• New private functions for artifact retrieval:

  • Added Get-GitHubArtifactById function to retrieve a specific artifact by its unique identifier.
  • Added Get-GitHubArtifactFromRepository function to list all artifacts for a given repository, with an option to include all versions.
  • Added Get-GitHubArtifactFromWorkflowRun function to list all artifacts from a specific workflow run, with an option to include all versions.

Type of change

• 📖 [Docs]
• 🪲 [Fix]
• 🩹 [Patch]
• ⚠️ [Security fix]
• 🚀 [Feature]
• 🌟 [Breaking change]

Checklist

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas

[Copilot]

Pull Request Overview

This PR updates the documentation for API function coverage related to managing Artifacts, reflecting the recently added functions. Key changes include updated counts for covered and missing functions, an increased overall coverage percentage, and modified endpoint statuses in the API endpoints table.

Files not reviewed (5)

• src/classes/public/Artifacts/GitHubArtifact.ps1: Language not supported
• src/formats/GitHubArtifact.Format.ps1xml: Language not supported
• src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1: Language not supported
• src/functions/public/API/Invoke-GitHubAPI.ps1: Language not supported
• src/functions/public/Artifacts/Get-GitHubArtifact.ps1: Language not supported

Comments suppressed due to low confidence (2)

Coverage.md:313

• Verify that the update from ':x:' to ':white_check_mark:' for the '/repos/{owner}/{repo}/actions/runs/{run_id}' endpoint accurately reflects the function coverage status after adding Artifact management functionalities.

| `/repos/{owner}/{repo}/actions/runs/{run_id}`                                                                             | :x:                | :white_check_mark: |                    |                    |                    |

Coverage.md:316

• Confirm that changing the status from ':x:' to ':white_check_mark:' for the '/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts' endpoint is intentional and reflects the new functionality coverage.

| `/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts`                                                                   |                    | :white_check_mark: |                    |                    |                    |

[github-actions]

Module GitHub - 0.20.0 published to the PowerShell Gallery.

[github-actions]

GitHub release for GitHub v0.20.0 has been created.