action.yml

name: S3 Cache Action
description:
    Allows to skip a job if it already succeeded for the same repo state. Uses S3 for caching.
author: Pleo OSS
inputs:
    bucket-name:
        description:
            Name of the S3 bucket to use for storing cache files. The job needs to have AWS
            credentials configured to allow read/write from this bucket.
        required: true
    key-prefix:
        description:
            Key prefix to add to the cache files key. By default the job ID is used. The full key
            used for the cache files is `cache/${repoOwner}/${repoName}/${keyPrefix}/${treeHash}`
        default: ${{ github.job }}
        required: false
    custom-hash:
        description:
            Hash calculated on the user's side used as part of the cache key for the job run.
        required: false
    aws-region:
        description: AWS region for the S3 bucket used for cache files. available.
        required: true
    aws-access-key-id:
        description:
            Access Key ID for an IAM user with permissions to read/write to the S3 bucket used for
            cache files.
        required: true
    aws-secret-access-key:
        description:
            Secret Access Key for an IAM user with permissions to read/write to the S3 bucket used
            for cache files.
        required: true
outputs:
    processed:
        description: Indicates if the job has already been performed for the current repo state.
    hash:
        description: The repo tree hash which was used for caching.
runs:
    using: node20
    main: dist/restore/index.js
    post: dist/save/index.js
    post-if: success()