Skip to content

fix: keep release notes out of package tree - #129

Merged
nutt-adam merged 1 commit into
mainfrom
codex/release-workflow-package-fix
May 4, 2026
Merged

fix: keep release notes out of package tree#129
nutt-adam merged 1 commit into
mainfrom
codex/release-workflow-package-fix

Conversation

@nutt-adam

@nutt-adam nutt-adam commented May 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fixes the v0.10.1 Release workflow failure in cargo package --locked.
  • Writes generated release notes to runner temp instead of the checkout so Cargo sees a clean package tree.

Validation

  • release.yml parsed as YAML locally
  • release note extraction writes to runner temp locally
  • cargo package --locked --allow-dirty --no-verify packaged successfully from the hotfix branch

Release impact

After merge, move tag v0.10.1 to the new main commit and push it to rerun the Release workflow.

Summary by CodeRabbit

  • Chores
    • Improved release notes generation and artifact upload reliability in the release workflow with a fallback mechanism for extraction failures.

@coderabbitai

coderabbitai Bot commented May 4, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: c6862d88-9b3c-4bb1-9cbc-044fe196a40a

📥 Commits

Reviewing files that changed from the base of the PR and between 7b6c803 and e786fb3.

📒 Files selected for processing (1)
  • .github/workflows/release.yml

📝 Walkthrough

Walkthrough

The release workflow now writes extracted changelog content to a runner-scoped temporary file with an explicit fallback to generated default release notes. The artifact upload step is updated to retrieve notes from the temp path instead of the repository working directory.

Changes

Release Notes Extraction & Upload

Layer / File(s) Summary
Changelog Extraction
.github/workflows/release.yml (lines 86–92)
Changelog extraction output redirects from workspace release-notes.md to $RUNNER_TEMP/release-notes.md with a fallback that writes a default header when awk extraction fails.
Artifact Upload
.github/workflows/release.yml (line 112)
Release notes artifact upload path changes to ${{ runner.temp }}/release-notes.md to match the temp file location.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • nutthouse/tutti#128: Modifies the same release workflow file to handle changelog/release notes extraction and upload with similar path and fallback adjustments.

Poem

🐰 A temp file springs to life with care,
Release notes nestle there with flair,
When extraction stumbles, never fear—
A fallback waits, steadfast and clear!
No artifacts left in working disarray!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers the issue being fixed and what changed, but lacks required versioning information including version selection, SemVer choice, and the explicit checkbox items from the template. Add the required Versioning section with version number, SemVer choice (PATCH applies here), and completed validation checkboxes per the template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix: keep release notes out of package tree' directly summarizes the main change—moving release notes generation to a runner temp path to maintain a clean package tree for cargo.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/release-workflow-package-fix

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@nutt-adam

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented May 4, 2026

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@nutt-adam
nutt-adam merged commit 47d49f8 into main May 4, 2026
11 checks passed
@nutt-adam
nutt-adam deleted the codex/release-workflow-package-fix branch May 4, 2026 23:29
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.

1 participant