This action enables caching dependencies to s3 compatible storage, e.g. minio, AWS S3
It also has github actions/cache@v2 fallback if s3 save & restore fails
name: dev cion: push: branches: [main]pull_request: branches: [main]jobs: build_test: runs-on: [ubuntu-latest]steps: - uses: tespkg/actions-cache@v1with: endpoint: play.min.io # optional, default s3.amazonaws.cominsecure: false # optional, use http instead of https. default falseaccessKey: "Q3AM3UQ867SPQQA43P2F"# requiredsecretKey: "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"# requiredsessionToken: "AQoDYXdzEJraDcqRtz123"# optionalbucket: actions-cache # requireduse-fallback: true # optional, use github actions cache fallback, default true# actions/cache compatible properties: https://github.com/actions/cachekey: ${{runner.os }}-yarn-${{hashFiles('**/yarn.lock') }}path: | node_modules .cacherestore-keys: | ${{runner.os }}-yarn-You can also set env instead of using with:
- uses: tespkg/actions-cache@v1env: AWS_ACCESS_KEY_ID: "Q3AM3UQ867SPQQA43P2F"AWS_SECRET_ACCESS_KEY: "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"# AWS_SESSION_TOKEN: "xxx"AWS_REGION: "us-east-1"with: endpoint: play.min.iobucket: actions-cacheuse-fallback: falsekey: test-${{runner.os }}-${{github.run_id }}path: | test-cache ~/test-cacheTo write to the cache only:
- uses: tespkg/actions-cache/save@v1with: accessKey: "Q3AM3UQ867SPQQA43P2F"# requiredsecretKey: "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"# requiredbucket: actions-cache # required# actions/cache compatible properties: https://github.com/actions/cachekey: ${{runner.os }}-yarn-${{hashFiles('**/yarn.lock') }}path: | node_modulesTo restore from the cache only:
- uses: tespkg/actions-cache/restore@v1with: accessKey: "Q3AM3UQ867SPQQA43P2F"# requiredsecretKey: "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"# requiredbucket: actions-cache # required# actions/cache compatible properties: https://github.com/actions/cachekey: ${{runner.os }}-yarn-${{hashFiles('**/yarn.lock') }}path: | node_modulesTo check if cache hits and size is not zero without downloading:
- name: Check cacheid: cacheuses: tespkg/actions-cache/check@v1with: accessKey: "Q3AM3UQ867SPQQA43P2F"# requiredsecretKey: "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"# requiredbucket: actions-cache # requiredlookup-only: truekey: ${{runner.os }}-yarn-${{hashFiles('**/yarn.lock') }}path: | node_modules - name: verify cache hitenv: CACHE_HIT: ${{steps.cache.outputs.cache-hit }}CACHE_SIZE: ${{steps.cache.outputs.cache-size }}run: | echo "CACHE_HIT $CACHE_HIT" echo "CACHE_SIZE $CACHE_SIZE"restore-keys works similar to how github's @actions/cache@v2 works: It search each item in restore-keys as prefix in object names and use the latest one
When using this with Amazon S3, the following permissions are necessary:
s3:PutObjects3:GetObjects3:ListBuckets3:GetBucketLocations3:ListBucketMultipartUploadss3:ListMultipartUploadParts
This project follows semantic versioning. Backward incompatible changes will increase major version.
There is also the v1 compatible tag that's always pinned to the latest v1.x.y release.
It's done using:
git tag -a v1 -f -m "v1 compatible release" git push -f --tags