search

reecetech / transfer-action

This action transfers data between self-hosted and GitHub-hosted runners
The Unlicense
0 stars 0 forks source link

readme

transfer-action

This action transfers data to/from artefact storage

Example usage

Checkout and upload repository

  checkout:
    runs-on: [self-hosted]
    steps:
      - name: Upload repo
        uses: reecetech/transfer-action@v2
        with:
          checkout: 'true'
          direction: 'upload'

Download repository

  run-on-mac:
    runs-on: [macOS-12]
    needs:
      - checkout
    steps:
      - name: Download repo
        uses: reecetech/transfer-action@v2
        with:
          checkout: 'true'
          direction: 'download'

Upload specific build results

      - id: upload
        name: Upload build output
        uses: reecetech/transfer-action@v2
        with:
          direction: 'upload'
          name: 'build-result'
          path: 'dist/'  # omit path to zip & upload everything under `./`

Download specific build results

      - name: Download build output
        uses: reecetech/transfer-action@v2
        with:
          direction: 'download'
          name: 'build-result'
          path: 'dist/'  # if not specifed, action would extract to the `./` path

Inputs

INPUT TYPE REQUIRED DEFAULT DESCRIPTION
checkout string false "false" Do a Git checkout before
transferring, either: true or false;
defaults to false
checkout-fetch-depth string false "1" Number of commits to fetch.
0 indicates all history for
all branches and tags
checkout-lfs string false "false" Whether to download Git-LFS files
direction string true Direction of transfer, either: upload
or download
if-no-files-found string false "error" The desired behavior if no
files are found using the
provided path. Available Options: warn:
Output a warning but do
not fail the action error:
Fail the action with an
error message ignore: Do not
output any warnings or errors,
the action does not fail
name string false Artifact name: defaults to checkout
if checkout input is true,
otherwise, please provide a value
path string false ⚠️ Conditional defaults! - if
checkout is true; then defaults
to ./.git/ - if checkout
is false; then defaults to
./ Additionally, the meaning of
path is: - if direction
is upload: a file, directory
or wildcard pattern that describes
what to upload; - if
direction is download: destination path

Outputs

OUTPUT TYPE DESCRIPTION
name string Artifact name