Custom actions to preserve file permissions when uploading and downloading artifacts in a Github Workflow

download-tar-action.yml

# File: .github/actions/download-tar/action.yml
name: Download Tar Artifact
description: >
  Download and extract a tar artifact that was previously uploaded in the workflow by the upload-tar
  action

inputs:
  name:
    description: Artifact name
  path:
    description: Destination path
    required: false

runs:
  using: composite
  steps:
    - uses: actions/[email protected]
      with:
        name: ${{ inputs.name }}
        path: ${{ inputs.path }}

    - run: ${{ github.action_path }}/untar.sh "${{ inputs.name }}"
      working-directory: ${{ inputs.path }}
      shell: bash

untar.sh

#!/usr/bin/env bash
# File: .github/actions/download-tar/untar.sh
set -x
name="$1"

if [[ "$name" == '' ]]; then
  dirs=(*/)
else
  dirs=(.)
fi

for dir in ${dirs[@]}; do
  echo "> Extracting: $dir"
  pushd "$dir" > /dev/null
  tar xvf artifact.tar
  rm artifact.tar
  popd > /dev/null
done

upload-tar-action.yml

# File: .github/actions/upload-tar/action.yml
name: Upload Tar Artifact
description: Compress files with tar prior to artifacting to keep file privileges.

inputs:
  name:
    description: Artifact name
  path:
    description: A directory path. The contents of that directory will be tarballed and uploaded.
    required: true

runs:
  using: composite
  steps:

    - run: tar cvf artifact.tar *
      shell: bash
      working-directory: ${{ inputs.path }}

    - uses: actions/[email protected]
      with:
        name: ${{ inputs.name }}
        path: ${{ inputs.path }}/artifact.tar
        overwrite: true

    - run: rm artifact.tar
      shell: bash
      working-directory: ${{ inputs.path }}

Hi,

inspired by the code from above, I was able to convert the provided code snippets into two drop-in-replacements, which are also listed in the GitHub Action marketplace:

• pyTooling/upload-artifacts
• pyTooling/download-artifacts

These Actions also implement all the parameters as used by the original Actions.

---

@rcdailey I saw your 👍 at actions/upload-artifact#38. Is it ok to have this comment and add the 2 links to my upload/download Actions, which used your ideas and these code snippets as an inspiration?

Hi there. Thank you for reaching out. I'm a bit unclear about what you're asking. It looks like you've already referred to my work in this comment. Could you please clarify your request? Are you looking for something specific beyond what you've already done, or is there another way I can help?

EDIT: After a second glance, I think I understand what you're asking. You want to have that same comment on my GIST here. Yes, I think that's perfectly fine. Thank you for taking my solution and formalizing it in a much nicer way! I may even use it myself :-)

Yes, that was my intent, but I wanted to ask first for permission :).
I'll modify the comment above.

Have fun using the actions - in case you find problems, just report them.