Skip to content

Fix README updates in auto-release workflow#2

Merged
88plug merged 5 commits into
mainfrom
copilot/fix-readme-update-issue-again
Feb 8, 2026
Merged

Fix README updates in auto-release workflow#2
88plug merged 5 commits into
mainfrom
copilot/fix-readme-update-issue-again

Conversation

Copy link
Copy Markdown

Copilot AI commented Feb 8, 2026

The auto-release workflow attempted to append to a non-existent ## Release History section in README.md, causing silent failures. Additionally, version numbers in the README's Environment Variables table were never updated when new releases were detected.

Changes

  • README.md: Added Release History section with table structure (Date | CUDA Tag | K3s Tag)
  • Workflow: Consolidated README updates into single awk pass that:
    • Updates K3S_TAG and CUDA_TAG version numbers in Environment Variables table
    • Appends timestamped entries to Release History table

Implementation

awk -v e="$entry" \
    -v k3s="${{ steps.k3s.outputs.latest }}" \
    -v cuda="${{ steps.cuda.outputs.latest }}" '
  /^## Release History/ { print; getline; print; print e; next }
  /^\| `K3S_TAG`/ { sub(/`v[0-9][^`]*-amd64`/, "`" k3s "`"); print; next }
  /^\| `CUDA_TAG`/ { sub(/`[0-9][^`]*-base-ubuntu[0-9.]*`/, "`" cuda "`"); print; next }
  { print }
' README.md > README.md.new && mv README.md.new README.md

Replaces two separate steps (sed for version updates, awk for history) with unified awk command that preserves formatting.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 4 commits February 8, 2026 17:16
Co-authored-by: 88plug <19512127+88plug@users.noreply.github.com>
Co-authored-by: 88plug <19512127+88plug@users.noreply.github.com>
…y sed

Co-authored-by: 88plug <19512127+88plug@users.noreply.github.com>
Co-authored-by: 88plug <19512127+88plug@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix readme not updating during action run Fix README updates in auto-release workflow Feb 8, 2026
Copilot AI requested a review from 88plug February 8, 2026 17:24
@88plug 88plug marked this pull request as ready for review February 8, 2026 17:29
@88plug 88plug merged commit d19e848 into main Feb 8, 2026
88plug added a commit that referenced this pull request Jun 3, 2026
Plus thesis: a thin, self-maintaining launcher whose CLI is the documented
front door and whose daily pipeline keeps EVERY pinned version in lockstep.

Bugs fixed:
- #1 [CODE]: README env-var table corrupted — auto-update awk /^\|----------/
  matched both the Env-Var and Release-History separators, injecting dated
  release rows into the Environment Variables table. Anchored to the Release
  History section only; cleaned the live-corrupted rows. (Prior 195-round
  reviews claimed this fixed; it was still broken in the committed README.)
- #2 [CODE]: License footer said "Apache 2.0" while project is FSL-1.1-ALv2
  (badge/LICENSE.md/PKGBUILD). Footer corrected.
- #3 [CODE]: Bundled device-plugin pinned v0.17.0; README v0.19.1; latest
  v0.19.2; the yml comment claimed auto-bump but the workflow never touched it.
  build-and-push now reads the bundled version, includes it in the update
  decision, bumps the manifest, and commits it. Static versions synced to
  v0.19.2 — the comment is now true.
- #4 [CODE]: cmd_test kubectl call was malformed (--command nvidia-smi with no
  -- separator, layered on a full --overrides spec). Reduced to one correct
  form driven by overrides.
- #5 [CODE]: script VERSION drifted from AUR pkgver (live: AUR aur-v0.1.1 vs
  repo 0.1.0). auto-release.yml now syncs scripts VERSION + PKGBUILD + .SRCINFO
  with the tag in one bot commit (loop-guarded by actor + [skip release] +
  GITHUB_TOKEN no-recursion).

Features added:
- #6 [CODE]: README never mentioned the k3d-gpu CLI the AUR package installs to
  /usr/bin — it documented raw `k3d cluster create` instead. Added a Quick
  Start (up/down/test/doctor/logs) with the env-var table.
- #7 [CODE]: cmd_test hardcoded a stale CUDA image; README used three different
  CUDA tags. Added K3D_GPU_TEST_IMAGE var (defaults to project CUDA tag);
  aligned README test snippets to 13.1.2-base-ubuntu24.04.

Skipped:
- Dockerfile redundant `COPY --from=k3s /bin /bin` — established upstream
  recipe, change carries regression risk for no clear gain.
- apt version pinning (hadolint DL3008) — below CI's error threshold, noisy.
- build-and-push page_size=100 single-page tag fetch (root cause of historical
  CUDA version regression) — a correct fix needs pagination that can't be
  validated offline against the live registry API.

Verify: shellcheck clean, bash -n ok, both workflows valid YAML, awk + version
seds simulated and confirmed (env table stays clean, .SRCINFO matches makepkg).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants