fix: handle missing files in update-version script by jdx · Pull Request #350 · jdx/hk

jdx · 2025-10-05T17:38:34Z

Summary

Fixes the release-plz workflow failure by rewriting the update-version script to avoid pipefail issues.

Problem

The update-version.sh script was failing during the release process:

[update-version] ERROR task failed
[release-plz] ERROR task failed

The original implementation used a pipeline with xargs and had set -o pipefail enabled:

rg 'pattern' --files-with-matches -0 | xargs -0 -r sed ...

With pipefail, if ANY command in a pipeline returns non-zero, the whole pipeline fails. This was causing the script to fail even when the commands executed successfully.

This blocked the release workflow: https://github.com/jdx/hk/actions/runs/18262051312/job/51991277623

Solution

Rewrote the script to avoid the problematic pipeline:

Removed -o pipefail from the shebang (changed from set -euxo pipefail to set -eux)
Replaced the rg | xargs pipeline with a while loop that:
- Captures the file list from rg into a variable (with || true to suppress non-zero exit)
- Only processes files if the list is non-empty
- Iterates over files directly without a pipeline

Before:

set -euxo pipefail
rg 'pattern' --files-with-matches -0 | xargs -0 -r "$SED" -i "..."

After:

set -eux
files=$(rg 'pattern' --files-with-matches || true)
if [[ -n "$files" ]]; then
    echo "$files" | while IFS= read -r file; do
        "$SED" -i "..." "$file"
    done
fi

Testing

Tested locally on macOS with gsed - successfully updates all version strings
Script handles both cases: when files match the pattern and when they don't
Will verify release-plz workflow succeeds in CI

Related to #349 (Windows build fix)

🤖 Generated with Claude Code

The update-version.sh script was failing when ripgrep found no matching files, because xargs would try to run sed with no input, causing "sed: no input files" error. Added the `-r` flag to xargs, which prevents it from running the command when there's no input. This allows the script to succeed gracefully when no version strings need to be updated. Fixes the release-plz workflow failure where the script would fail during version bumps when no package:// URLs existed in the repository yet. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

@joonas

## [1.18.0](https://github.com/jdx/hk/compare/v1.17.0..v1.18.0) - 2025-10-05 ### 🚀 Features - add fix-smart-quotes util by [@joonas](https://github.com/joonas) in [#348](#348) ### 🐛 Bug Fixes - add Windows support by guarding Unix-specific file permission APIs by [@jdx](https://github.com/jdx) in [#349](#349) - handle missing files in update-version script by [@jdx](https://github.com/jdx) in [#350](#350) - rewrite update-version script to avoid pipefail issues by [@jdx](https://github.com/jdx) in [211b1ac](211b1ac) - run render before update-version in release script by [@jdx](https://github.com/jdx) in [35d2df3](35d2df3) - use [0-9] instead of \d in ripgrep pattern for better compatibility by [@jdx](https://github.com/jdx) in [cf8ebb0](cf8ebb0) - explicitly specify search path for ripgrep in update-version script by [@jdx](https://github.com/jdx) in [5666f96](5666f96) ### 🔍 Other Changes - add diagnostic output to update-version script by [@jdx](https://github.com/jdx) in [aaeea63](aaeea63) - add more file existence checks by [@jdx](https://github.com/jdx) in [cbace40](cbace40) - test rg pattern matching in CI environment by [@jdx](https://github.com/jdx) in [a52ea46](a52ea46) ### New Contributors - @joonas made their first contribution in [#348](#348)  --- > [!NOTE] > Bumps hk to 1.18.0, updates docs/CLI/templates to new Pkl package URLs, and refreshes a dependency. > > - **Version bump**: > - Set crate/app version to `1.18.0` in `Cargo.toml`, `Cargo.lock` (package `hk`), `hk.usage.kdl`, `docs/cli/commands.json`, and `docs/cli/index.md`. > - **Docs/examples**: > - Update `amends`/`import` URLs from `v1.2.0` to `v1.18.0` across `docs/*`, `hk-example.pkl`, and example `.pkl` files. > - Add `CHANGELOG.md` entry for `1.18.0`. > - **CLI/templates**: > - Update init template in `src/cli/init.rs` to use `v1.18.0` URLs. > - Refresh error hint URL in `src/config.rs` to `v1.18.0`. > - **Dependencies**: > - Bump `flate2` to `1.1.4` in `Cargo.lock`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit fc59481. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>  Co-authored-by: mise-en-dev <[email protected]>

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [hk](https://github.com/jdx/hk) | minor | `1.15.7` -> `1.18.3` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>jdx/hk (hk)</summary> ### [`v1.18.3`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1183---2025-10-07) [Compare Source](jdx/hk@v1.18.2...v1.18.3) ##### 🐛 Bug Fixes - stash untracked files during partial stashes when HK\_STASH\_UNTRACKED=true by [@jdx](https://github.com/jdx) in [#357](jdx/hk#357) ### [`v1.18.2`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1182---2025-10-06) [Compare Source](jdx/hk@v1.18.1...v1.18.2) ##### 🐛 Bug Fixes - stage directive to include untracked files matching globs by [@jdx](https://github.com/jdx) in [#355](jdx/hk#355) ### [`v1.18.1`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1181---2025-10-05) [Compare Source](jdx/hk@v1.18.0...v1.18.1) ##### 🐛 Bug Fixes - prevent race condition when files are deleted between collection and execution by [@jdx](https://github.com/jdx) in [#353](jdx/hk#353) ### [`v1.18.0`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1180---2025-10-05) [Compare Source](jdx/hk@v1.16.0...v1.18.0) ##### 🚀 Features - add fix-smart-quotes util by [@joonas](https://github.com/joonas) in [#348](jdx/hk#348) ##### 🐛 Bug Fixes - add Windows support by guarding Unix-specific file permission APIs by [@jdx](https://github.com/jdx) in [#349](jdx/hk#349) - handle missing files in update-version script by [@jdx](https://github.com/jdx) in [#350](jdx/hk#350) - rewrite update-version script to avoid pipefail issues by [@jdx](https://github.com/jdx) in [211b1ac](jdx/hk@211b1ac) - run render before update-version in release script by [@jdx](https://github.com/jdx) in [35d2df3](jdx/hk@35d2df3) - use \[0-9] instead of \d in ripgrep pattern for better compatibility by [@jdx](https://github.com/jdx) in [cf8ebb0](jdx/hk@cf8ebb0) - explicitly specify search path for ripgrep in update-version script by [@jdx](https://github.com/jdx) in [5666f96](jdx/hk@5666f96) ##### 🔍 Other Changes - add diagnostic output to update-version script by [@jdx](https://github.com/jdx) in [aaeea63](jdx/hk@aaeea63) - add more file existence checks by [@jdx](https://github.com/jdx) in [cbace40](jdx/hk@cbace40) - test rg pattern matching in CI environment by [@jdx](https://github.com/jdx) in [a52ea46](jdx/hk@a52ea46) ##### New Contributors - [@joonas](https://github.com/joonas) made their first contribution in [#348](jdx/hk#348) ### [`v1.16.0`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1160---2025-10-02) [Compare Source](jdx/hk@v1.15.7...v1.16.0) ##### 🚀 Features - add HK\_STAGE setting to control automatic staging of fixed files by [@jdx](https://github.com/jdx) in [#313](jdx/hk#313) - suppress check output\_summary when fixer runs with check\_first by [@jdx](https://github.com/jdx) in [#315](jdx/hk#315) ##### 🐛 Bug Fixes - \--slow flag now properly enables slow profile by [@jdx](https://github.com/jdx) in [#317](jdx/hk#317) ##### 📚 Documentation - Update getting\_started.md by [@jdx](https://github.com/jdx) in [a8c1a35](jdx/hk@a8c1a35) ##### 🔍 Other Changes - Update getting\_started.md by [@jdx](https://github.com/jdx) in [58c0564](jdx/hk@58c0564) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

jdx merged commit a13a4a5 into main Oct 5, 2025
9 checks passed

jdx deleted the fix-update-version-xargs branch October 5, 2025 17:39

jdx mentioned this pull request Oct 5, 2025

chore: release v1.18.0 #351

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

fix: handle missing files in update-version script#350

fix: handle missing files in update-version script#350
jdx merged 1 commit intomainfrom
fix-update-version-xargs

jdx commented Oct 5, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

Conversation

jdx commented Oct 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Problem

Solution

Testing

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

jdx commented Oct 5, 2025 •

edited

Loading