From ca3b9ac762955fad216e3d8e0bbf22087071c89c Mon Sep 17 00:00:00 2001 From: Pavel Zwerschke Date: Fri, 19 Jan 2024 07:56:38 +0200 Subject: [PATCH] Add cwd sha to cache key (#68) --- README.md | 20 ++++++++++---------- dist/index.js | 4 +++- package.json | 2 +- src/cache.ts | 5 ++++- 4 files changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 063089c3..9272c5f6 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ GitHub Action to set up the [pixi](https://github.com/prefix-dev/pixi) package m ## Usage ```yml -- uses: prefix-dev/setup-pixi@v0.4.2 +- uses: prefix-dev/setup-pixi@v0.4.3 with: pixi-version: v0.12.0 cache: true @@ -34,7 +34,7 @@ GitHub Action to set up the [pixi](https://github.com/prefix-dev/pixi) package m > [!WARNING] > Since pixi is not yet stable, the API of this action may change between minor versions. -> Please pin the versions of this action to a specific version (i.e., `prefix-dev/setup-pixi@v0.4.2`) to avoid breaking changes. +> Please pin the versions of this action to a specific version (i.e., `prefix-dev/setup-pixi@v0.4.3`) to avoid breaking changes. > You can automatically update the version of this action by using [Dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot). > > Put the following in your `.github/dependabot.yml` file to enable Dependabot for your GitHub Actions: @@ -73,7 +73,7 @@ In order to not exceed the [10 GB cache size limit](https://docs.github.com/en/a This can be done by setting the `cache-write` argument. ```yml -- uses: prefix-dev/setup-pixi@v0.4.2 +- uses: prefix-dev/setup-pixi@v0.4.3 with: cache: true cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }} @@ -100,7 +100,7 @@ Specify the token using the `auth-token` input argument. This form of authentication (bearer token in the request headers) is mainly used at [prefix.dev](https://prefix.dev). ```yml -- uses: prefix-dev/setup-pixi@v0.4.2 +- uses: prefix-dev/setup-pixi@v0.4.3 with: auth-host: prefix.dev auth-token: ${{ secrets.PREFIX_DEV_TOKEN }} @@ -112,7 +112,7 @@ Specify the username and password using the `auth-username` and `auth-password` This form of authentication (HTTP Basic Auth) is used in some enterprise environments with [artifactory](https://jfrog.com/artifactory) for example. ```yml -- uses: prefix-dev/setup-pixi@v0.4.2 +- uses: prefix-dev/setup-pixi@v0.4.3 with: auth-host: custom-artifactory.com auth-username: ${{ secrets.PIXI_USERNAME }} @@ -125,7 +125,7 @@ Specify the conda-token using the `conda-token` input argument. This form of authentication (token is encoded in URL: `https://my-quetz-instance.com/t//get/custom-channel`) is used at [anaconda.org](https://anaconda.org) or with [quetz instances](https://github.com/mamba-org/quetz). ```yml -- uses: prefix-dev/setup-pixi@v0.4.2 +- uses: prefix-dev/setup-pixi@v0.4.3 with: auth-host: anaconda.org # or my-quetz-instance.com conda-token: ${{ secrets.CONDA_TOKEN }} @@ -163,7 +163,7 @@ You can specify whether `setup-pixi` should run `pixi install --frozen` or `pixi See the [official documentation](https://prefix.dev/docs/pixi/cli#install) for more information about the `--frozen` and `--locked` flags. ```yml -- uses: prefix-dev/setup-pixi@v0.4.2 +- uses: prefix-dev/setup-pixi@v0.4.3 with: locked: true # or @@ -182,7 +182,7 @@ The first one is the debug logging of the action itself. This can be enabled by running the action with the `RUNNER_DEBUG` environment variable set to `true`. ```yml -- uses: prefix-dev/setup-pixi@v0.4.2 +- uses: prefix-dev/setup-pixi@v0.4.3 env: RUNNER_DEBUG: true ``` @@ -200,7 +200,7 @@ The second type is the debug logging of the pixi executable. This can be specified by setting the `log-level` input. ```yml -- uses: prefix-dev/setup-pixi@v0.4.2 +- uses: prefix-dev/setup-pixi@v0.4.3 with: # one of `q`, `default`, `v`, `vv`, or `vvv`. log-level: vvv @@ -226,7 +226,7 @@ If nothing is specified, `setup-pixi` will default to `true`. On self-hosted runners, you also might want to alter the default pixi install location to a temporary location. You can use `pixi-bin-path: ${{ runner.temp }}/bin/pixi` to do this. ```yml -- uses: prefix-dev/setup-pixi@v0.4.2 +- uses: prefix-dev/setup-pixi@v0.4.3 with: post-cleanup: true # ${{ runner.temp }}\Scripts\pixi.exe on Windows diff --git a/dist/index.js b/dist/index.js index 4134ae0a..05075f5b 100644 --- a/dist/index.js +++ b/dist/index.js @@ -61235,7 +61235,9 @@ var generateCacheKey = async (cacheKeyPrefix) => Promise.all([import_promises.de core3.debug(`pixiSha: ${pixiSha}`); const lockfilePathSha = sha256(options.pixiLockFile); core3.debug(`lockfilePathSha: ${lockfilePathSha}`); - const sha = sha256(lockfileSha + lockfilePathSha + pixiSha); + const cwdSha = sha256(process.cwd()); + core3.debug(`cwdSha: ${cwdSha}`); + const sha = sha256(lockfileSha + pixiSha + lockfilePathSha + cwdSha); core3.debug(`sha: ${sha}`); return `${cacheKeyPrefix}${getCondaArch()}-${sha}`; }).catch((err) => { diff --git a/package.json b/package.json index fbf3f4db..69ebcab5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "setup-pixi", - "version": "0.4.2", + "version": "0.4.3", "private": true, "description": "Action to set up the pixi package manager.", "scripts": { diff --git a/src/cache.ts b/src/cache.ts index 9cfb6d3d..39e3caca 100644 --- a/src/cache.ts +++ b/src/cache.ts @@ -16,7 +16,10 @@ export const generateCacheKey = async (cacheKeyPrefix: string) => // since conda envs are not relocatable, we need to include the path in the cache key const lockfilePathSha = sha256(options.pixiLockFile) core.debug(`lockfilePathSha: ${lockfilePathSha}`) - const sha = sha256(lockfileSha + lockfilePathSha + pixiSha) + // since the lockfile path is not necessarily absolute, we need to include the cwd in the cache key + const cwdSha = sha256(process.cwd()) + core.debug(`cwdSha: ${cwdSha}`) + const sha = sha256(lockfileSha + pixiSha + lockfilePathSha + cwdSha) core.debug(`sha: ${sha}`) return `${cacheKeyPrefix}${getCondaArch()}-${sha}` })