🌟 [Major]: Add Path parameter to replace WorkingDirectory (#3)

## Description

This pull request includes changes to the `README.md` and `action.yml`
files to update the artifact download process and correct the path
usage. This includes the renaming of the `WorkingDirectory` input to
`Path`, updating the `README.md` to reflect this change, and modifying
the script path in the `action.yml`.

Updates to artifact download process:

*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L12-R17):
Renamed `WorkingDirectory` input to `Path` and updated the description
to reflect the new input name.
*
[`action.yml`](diffhunk://#diff-1243c5424efaaa19bd8e813c5e6f6da46316e63761421b3e5f5c8ced9a36e6b6L9-R11):
Renamed `WorkingDirectory` input to `Path` and updated the description
accordingly.
[[1]](diffhunk://#diff-1243c5424efaaa19bd8e813c5e6f6da46316e63761421b3e5f5c8ced9a36e6b6L9-R11)
[[2]](diffhunk://#diff-1243c5424efaaa19bd8e813c5e6f6da46316e63761421b3e5f5c8ced9a36e6b6R28-R30)

Path usage correction:

*
[`action.yml`](diffhunk://#diff-1243c5424efaaa19bd8e813c5e6f6da46316e63761421b3e5f5c8ced9a36e6b6L42-R51):
Modified the script path from backslashes to forward slashes for
compatibility.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

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

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

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

Author: MariusStorhaug

README.md

@@ -9,11 +9,12 @@ As an example, terraform plans can be uploaded as artifacts in a PR CI workflow
 
 | Name | Description | Required | Default |
 | - | - | - | - |
-| `WorkingDirectory` | The working directory where the artifact will be downloaded to. Default is the root of the repository. | No |  |
+| `Path` | The path to the artifact to download. | No | |
 | `WorkflowID` | The filename or ID of the workflow to download the artifact from. You must provide either `WorkflowID` or `WorkflowRunID`. | No | '' |
 | `WorkflowRunID` | The ID of the workflow run where the artifact will be download from. You must provide either `WorkflowID` or `WorkflowRunID`. | No | '' |
-| `ArtifactName` | Name of the artifact to download. If unspecified, all artifacts for the run are downloaded. | Yes |  |
-| `GITHUB_TOKEN` | The GitHub token used to authenticate with the GitHub API. | Yes |  |
+| `ArtifactName` | Name of the artifact to download. If unspecified, all artifacts for the run are downloaded. | Yes | |
+| `GITHUB_TOKEN` | The GitHub token used to authenticate with the GitHub API. | Yes | |
+| `WorkingDirectory` | The working directory where the artifact will be downloaded to. Default is the root of the repository. | No | `${{ github.workspace }}` |
 
 ### Outputs
 

action.yml

@@ -6,8 +6,8 @@ branding:
   color: white
 
 inputs:
-  WorkingDirectory:
-    description: The working directory where the artifact will be downloaded to. Default is the root of the repository.
+  Path:
+    description: The path to the artifact to download.
     required: false
   WorkflowID:
     description: The filename or ID of the workflow to download the artifact from. You must provide either `WorkflowID` or `WorkflowRunID`.
@@ -25,6 +25,9 @@ inputs:
   GITHUB_TOKEN:
     description: The GitHub token used to authenticate with the GitHub API.
     required: true
+  WorkingDirectory:
+    description: The working directory where the artifact will be downloaded to. Default is the root of the repository.
+    required: false
 
 runs:
   using: composite
@@ -35,16 +38,17 @@ runs:
       working-directory: ${{ inputs.WorkingDirectory }}
       env:
         GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}
-        GITHUB_ACTION_INPUT_WorkflowID: ${{ inputs.WorkflowID }}
-        GITHUB_ACTION_INPUT_WorkflowRunID: ${{ inputs.WorkflowRunID }}
+        PSMODULE_DOWNLOAD_CIARTIFACT_INPUT_Path: ${{ inputs.Path }}
+        PSMODULE_DOWNLOAD_CIARTIFACT_INPUT_WorkflowID: ${{ inputs.WorkflowID }}
+        PSMODULE_DOWNLOAD_CIARTIFACT_INPUT_WorkflowRunID: ${{ inputs.WorkflowRunID }}
       run: |
         # Download-CIArtifact
-        ${{ github.action_path }}\scripts\main.ps1
+        ${{ github.action_path }}/scripts/main.ps1
 
     - name: Download Artifact
       uses: actions/download-artifact@v4
       with:
         name: ${{ inputs.ArtifactName }}
-        path: ${{ inputs.WorkingDirectory }}
+        path: ${{ steps.workflow_run_id.outputs.Path }}
         github-token: ${{ github.token }}
         run-id: ${{ steps.workflow_run_id.outputs.RunID }}

scripts/main.ps1

@@ -1,36 +1,41 @@
-[CmdletBinding(DefaultParameterSetName = 'WorkflowID')]
-param(
-    # The ID of the workflow to get the run for.
-    [Parameter()]
-    [string] $WorkflowID = $env:GITHUB_ACTION_INPUT_WorkflowID,
-
-    # The ID of the workflow run to verify.
-    [Parameter()]
-    [string] $WorkflowRunID = $env:GITHUB_ACTION_INPUT_WorkflowRunID
-)
-
-if ($WorkflowRunID) {
-    Write-Output '::group::Verify Workflow Run'
-    gh api -H 'Accept: application/vnd.github+json' -H 'X-GitHub-Api-Version: 2022-11-28' "/repos/$env:GITHUB_REPOSITORY/actions/runs/$WorkflowRunID"
-    Write-Output '::endgroup::'
-} else {
-    Write-Output '::group::Get PR'
-    $PR = gh api -H 'Accept: application/vnd.github+json' -H 'X-GitHub-Api-Version: 2022-11-28' `
-        "/repos/$env:GITHUB_REPOSITORY/commits/$env:GITHUB_SHA/pulls" | ConvertFrom-Json
-    $PR | ConvertTo-Json -Depth 100
-    if ($PR.Count -ne 1) {
-        throw "Expected 1 PR, but found [$($PR.Count)]."
-    }
-    Write-Output '::endgroup::'
-
-    Write-Output '::group::Get WorkflowRun'
-    $WorkflowRuns = gh api -H 'Accept: application/vnd.github+json' -H 'X-GitHub-Api-Version: 2022-11-28' `
-        "/repos/$env:GITHUB_REPOSITORY/actions/workflows/$WorkflowID/runs?head_sha=$($PR.head.sha)" |
-        ConvertFrom-Json | Select-Object -ExpandProperty workflow_runs
-    $WorkflowRuns | ConvertTo-Json -Depth 100
-    $WorkflowRunID = $WorkflowRuns.id
-    Write-Output '::endgroup::'
-}
-
-Write-Output "Workflow Run ID: [$WorkflowRunID]"
-"RunID=$WorkflowRunID" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
+[CmdletBinding(DefaultParameterSetName = 'WorkflowID')]
+param(
+    # The ID of the workflow to get the run for.
+    [Parameter()]
+    [string] $WorkflowID = $env:PSMODULE_DOWNLOAD_CIARTIFACT_INPUT_WorkflowID,
+
+    # The ID of the workflow run to verify.
+    [Parameter()]
+    [string] $WorkflowRunID = $env:PSMODULE_DOWNLOAD_CIARTIFACT_INPUT_WorkflowRunID
+)
+
+if ($WorkflowRunID) {
+    Write-Output '::group::Verify Workflow Run'
+    gh api -H 'Accept: application/vnd.github+json' -H 'X-GitHub-Api-Version: 2022-11-28' "/repos/$env:GITHUB_REPOSITORY/actions/runs/$WorkflowRunID"
+    Write-Output '::endgroup::'
+} else {
+    Write-Output '::group::Get PR'
+    $PR = gh api -H 'Accept: application/vnd.github+json' -H 'X-GitHub-Api-Version: 2022-11-28' `
+        "/repos/$env:GITHUB_REPOSITORY/commits/$env:GITHUB_SHA/pulls" | ConvertFrom-Json
+    $PR | ConvertTo-Json -Depth 100
+    if ($PR.Count -ne 1) {
+        throw "Expected 1 PR, but found [$($PR.Count)]."
+    }
+    Write-Output '::endgroup::'
+
+    Write-Output '::group::Get WorkflowRun'
+    $WorkflowRuns = gh api -H 'Accept: application/vnd.github+json' -H 'X-GitHub-Api-Version: 2022-11-28' `
+        "/repos/$env:GITHUB_REPOSITORY/actions/workflows/$WorkflowID/runs?head_sha=$($PR.head.sha)" |
+        ConvertFrom-Json | Select-Object -ExpandProperty workflow_runs
+    $WorkflowRuns | ConvertTo-Json -Depth 100
+    $WorkflowRunID = $WorkflowRuns.id
+    Write-Output '::endgroup::'
+}
+
+Write-Output "Workflow Run ID: [$WorkflowRunID]"
+"RunID=$WorkflowRunID" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
+
+$path = [string]::IsNullOrEmpty($env:PSMODULE_DOWNLOAD_CIARTIFACT_INPUT_Path) ? '.' : $env:PSMODULE_DOWNLOAD_CIARTIFACT_INPUT_Path
+$path = Resolve-Path -Path $path | Select-Object -ExpandProperty Path
+
+"Path=$path" | Out-File -FilePath $env:GITHUB_OUTPUT -Append