This action uploads any files as build artifacts in your GitHub Actions workflow. It's a wrapper around actions/upload-artifact with an additional artifact output, which is a JSON string with extended artifact metadata, and default path input set to ${INPUT_NAME}.tar.

To be paired with the download-artifact action, which is again a wrapper around actions/download-artifact with an additional artifact input that accepts the extended artifact metadata JSON string.

Both actions together allow you to easily perform cross-workflow-run or even cross-repository artifact transfers with just a single variable being passed around.

- name: "Upload artifact"
  id: 'UPLOAD'
  uses: 'actions-rindeal/upload-artifact@v4'
  with:
    'name': 'my-artifact'
    # will upload `${GITHUB_WORKSPACE}/my-artifact.tar` file

Example of passing the metadata around:

with:
  'artifact': ${{ toJSON(fromJSON(steps['UPLOAD'].outputs['ARTIFACT'])) }}

Example of accessing the metadata props:

env:
  'ARTIFACT_NAME':  ${{ fromJSON(steps['UPLOAD'].outputs['ARTIFACT']).name }}
  'ARTIFACT_WF_ID': ${{ fromJSON(steps['UPLOAD'].outputs['ARTIFACT']).workflow_run.id }}

The artifact output provides a JSON object with detailed information about the uploaded artifact. Here's an example:

{
  "id": 1676293972,
  "name": "my-artifact",
  "url": "https://api.github.com/repos/octo-org/octo-repo/actions/artifacts/1676293972",
  "archive_download_url": "https://api.github.com/repos/octo-org/octo-repo/actions/artifacts/1676293972/zip",
  "workflow_run": {
    "id": 9834162510,
    "repository_full_name": "octo-org/octo-repo",
    "repository_id": 1234567,
    "head_repository_id": 1234567,
    "head_branch": "master",
    "head_sha": "a9eb7e22d2c4809bf15c5beff6399ffe25f79f59"
  }
}

For more details on artifact handling in GitHub Actions, refer to the official documentation.