From a05a582c56a6511c1a13b940d7c761d5c1430309 Mon Sep 17 00:00:00 2001 From: Kevin Stillhammer Date: Sun, 16 Mar 2025 22:15:17 +0100 Subject: [PATCH] Warn when the workdir is empty (#322) Closes: #306 --- README.md | 21 +++++++++++++++++++++ action.yml | 3 +++ dist/save-cache/index.js | 3 ++- dist/setup/index.js | 14 +++++++++++++- src/setup-uv.ts | 16 ++++++++++++++++ src/utils/inputs.ts | 2 ++ 6 files changed, 57 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6768995..a7d1b78 100644 --- a/README.md +++ b/README.md @@ -279,6 +279,20 @@ If you want to ignore this, set the `ignore-nothing-to-cache` input to `true`. ignore-nothing-to-cache: true ``` +### Ignore empty workdir + +By default, the action will warn if the workdir is empty, because this is usually the case when +`actions/checkout` is configured to run after `setup-uv`, which is not supported. + +If you want to ignore this, set the `ignore-empty-workdir` input to `true`. + +```yaml +- name: Ignore empty workdir + uses: astral-sh/setup-uv@v5 + with: + ignore-empty-workdir: true +``` + ### GitHub authentication token This action uses the GitHub API to fetch the uv release artifacts. To avoid hitting the GitHub API @@ -447,6 +461,13 @@ The reason for the warning is, that we have to way to know if this is the first cache key or the user accidentally misconfigured the [cache-dependency-glob](#cache-dependency-glob) or [cache-suffix](#enable-caching) and the cache never gets used. +### Do I have to run `actions/checkout` before or after `setup-uv`? + +Some workflows need uv but do not need to access the repository content. + +But **if** you need to access the repository content, you have run `actions/checkout` before running `setup-uv`. +Running `actions/checkout` after `setup-uv` **is not supported**. + ## Acknowledgements `setup-uv` was initially written and published by [Kevin Stillhammer](https://github.com/eifinger) diff --git a/action.yml b/action.yml index 9c6893c..3327f72 100644 --- a/action.yml +++ b/action.yml @@ -45,6 +45,9 @@ inputs: ignore-nothing-to-cache: description: "Ignore when nothing is found to cache." default: "false" + ignore-empty-workdir: + description: "Ignore when the working directory is empty." + default: "false" tool-dir: description: "Custom path to set UV_TOOL_DIR to." required: false diff --git a/dist/save-cache/index.js b/dist/save-cache/index.js index 52c503c..5e2ac20 100644 --- a/dist/save-cache/index.js +++ b/dist/save-cache/index.js @@ -88914,7 +88914,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", ({ value: true })); -exports.githubToken = exports.toolDir = exports.toolBinDir = exports.ignoreNothingToCache = exports.pruneCache = exports.cacheDependencyGlob = exports.cacheLocalPath = exports.cacheSuffix = exports.enableCache = exports.checkSum = exports.pythonVersion = exports.uvFile = exports.pyProjectFile = exports.version = void 0; +exports.githubToken = exports.toolDir = exports.toolBinDir = exports.ignoreEmptyWorkdir = exports.ignoreNothingToCache = exports.pruneCache = exports.cacheDependencyGlob = exports.cacheLocalPath = exports.cacheSuffix = exports.enableCache = exports.checkSum = exports.pythonVersion = exports.uvFile = exports.pyProjectFile = exports.version = void 0; const core = __importStar(__nccwpck_require__(7484)); const node_path_1 = __importDefault(__nccwpck_require__(6760)); exports.version = core.getInput("version"); @@ -88928,6 +88928,7 @@ exports.cacheLocalPath = getCacheLocalPath(); exports.cacheDependencyGlob = core.getInput("cache-dependency-glob"); exports.pruneCache = core.getInput("prune-cache") === "true"; exports.ignoreNothingToCache = core.getInput("ignore-nothing-to-cache") === "true"; +exports.ignoreEmptyWorkdir = core.getInput("ignore-empty-workdir") === "true"; exports.toolBinDir = getToolBinDir(); exports.toolDir = getToolDir(); exports.githubToken = core.getInput("github-token"); diff --git a/dist/setup/index.js b/dist/setup/index.js index 6e629e0..628c636 100644 --- a/dist/setup/index.js +++ b/dist/setup/index.js @@ -119746,6 +119746,7 @@ const exec = __importStar(__nccwpck_require__(5236)); const node_fs_1 = __importDefault(__nccwpck_require__(3024)); const pyproject_1 = __nccwpck_require__(3929); async function run() { + detectEmptyWorkdir(); const platform = await (0, platforms_1.getPlatform)(); const arch = (0, platforms_1.getArch)(); try { @@ -119773,6 +119774,16 @@ async function run() { core.setFailed(err.message); } } +function detectEmptyWorkdir() { + if (node_fs_1.default.readdirSync(".").length === 0) { + if (inputs_1.ignoreEmptyWorkdir) { + core.info("Empty workdir detected. Ignoring because ignore-empty-workdir is enabled"); + } + else { + core.warning("Empty workdir detected. This may cause unexpected behavior. You can enable ignore-empty-workdir to mute this warning."); + } + } +} async function setupUv(platform, arch, checkSum, githubToken) { const resolvedVersion = await determineVersion(); const toolCacheResult = (0, download_version_1.tryGetFromToolCache)(arch, resolvedVersion); @@ -119927,7 +119938,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", ({ value: true })); -exports.githubToken = exports.toolDir = exports.toolBinDir = exports.ignoreNothingToCache = exports.pruneCache = exports.cacheDependencyGlob = exports.cacheLocalPath = exports.cacheSuffix = exports.enableCache = exports.checkSum = exports.pythonVersion = exports.uvFile = exports.pyProjectFile = exports.version = void 0; +exports.githubToken = exports.toolDir = exports.toolBinDir = exports.ignoreEmptyWorkdir = exports.ignoreNothingToCache = exports.pruneCache = exports.cacheDependencyGlob = exports.cacheLocalPath = exports.cacheSuffix = exports.enableCache = exports.checkSum = exports.pythonVersion = exports.uvFile = exports.pyProjectFile = exports.version = void 0; const core = __importStar(__nccwpck_require__(7484)); const node_path_1 = __importDefault(__nccwpck_require__(6760)); exports.version = core.getInput("version"); @@ -119941,6 +119952,7 @@ exports.cacheLocalPath = getCacheLocalPath(); exports.cacheDependencyGlob = core.getInput("cache-dependency-glob"); exports.pruneCache = core.getInput("prune-cache") === "true"; exports.ignoreNothingToCache = core.getInput("ignore-nothing-to-cache") === "true"; +exports.ignoreEmptyWorkdir = core.getInput("ignore-empty-workdir") === "true"; exports.toolBinDir = getToolBinDir(); exports.toolDir = getToolDir(); exports.githubToken = core.getInput("github-token"); diff --git a/src/setup-uv.ts b/src/setup-uv.ts index c6e1df9..52f72f0 100644 --- a/src/setup-uv.ts +++ b/src/setup-uv.ts @@ -16,6 +16,7 @@ import { import { cacheLocalPath, checkSum, + ignoreEmptyWorkdir, enableCache, githubToken, pyProjectFile, @@ -30,6 +31,7 @@ import fs from "node:fs"; import { getUvVersionFromConfigFile } from "./utils/pyproject"; async function run(): Promise { + detectEmptyWorkdir(); const platform = await getPlatform(); const arch = getArch(); @@ -61,6 +63,20 @@ async function run(): Promise { } } +function detectEmptyWorkdir(): void { + if (fs.readdirSync(".").length === 0) { + if (ignoreEmptyWorkdir) { + core.info( + "Empty workdir detected. Ignoring because ignore-empty-workdir is enabled", + ); + } else { + core.warning( + "Empty workdir detected. This may cause unexpected behavior. You can enable ignore-empty-workdir to mute this warning.", + ); + } + } +} + async function setupUv( platform: Platform, arch: Architecture, diff --git a/src/utils/inputs.ts b/src/utils/inputs.ts index 6f72236..cb1dcc5 100644 --- a/src/utils/inputs.ts +++ b/src/utils/inputs.ts @@ -13,6 +13,8 @@ export const cacheDependencyGlob = core.getInput("cache-dependency-glob"); export const pruneCache = core.getInput("prune-cache") === "true"; export const ignoreNothingToCache = core.getInput("ignore-nothing-to-cache") === "true"; +export const ignoreEmptyWorkdir = + core.getInput("ignore-empty-workdir") === "true"; export const toolBinDir = getToolBinDir(); export const toolDir = getToolDir(); export const githubToken = core.getInput("github-token");