Skip to content

docs(release): use versioned asset names - #393

Merged
Astro-Han merged 1 commit into
devfrom
pawwork/release-checklist-versioned-assets
May 2, 2026
Merged

docs(release): use versioned asset names#393
Astro-Han merged 1 commit into
devfrom
pawwork/release-checklist-versioned-assets

Conversation

@Astro-Han

@Astro-Han Astro-Han commented May 2, 2026

Copy link
Copy Markdown
Owner

Summary

  • Updates the release notes download link template to use versioned installer asset names.
  • Updates the release verifier description to match the versioned installer and updater asset names checked by the helper.

Why

The release checklist still showed unversioned asset names in the Release Notes template and verifier summary, which could point maintainers at the wrong GitHub release assets.

Related Issue

No linked issue; this is a small release-process documentation fix.

Human Review Status

Pending. A human should make the final merge decision after reviewing the final diff and verification evidence.

Review Focus

Please confirm the placeholder asset names match the verifier's pawwork-<platform>-<arch>-X.Y.Z naming convention.

Risk Notes

None. Documentation-only change.

How To Verify

Diff check: git diff --check -- .github/RELEASE_CHECKLIST.md completed with no output
Manual diff review: confirmed only .github/RELEASE_CHECKLIST.md changed
Repository check: gh repo view confirmed Astro-Han/pawwork with default branch dev

Screenshots or Recordings

Not required; no visible UI changes.

Checklist

  • Human review status is stated above as pending, approved, or not required
  • I linked the related issue, or stated why there is no issue
  • This PR has type, scope, and priority labels, or I requested maintainer labeling
  • I described the review focus and any meaningful risks
  • I listed the relevant verification steps and the key result for each
  • I did not introduce unrelated refactors, dependencies, generated files, or file changes beyond the stated scope
  • I manually checked visible UI or copy changes when needed, with screenshots or recordings
  • I considered macOS and Windows impact for desktop, packaging, updater, signing, paths, shell, or permissions changes
  • I called out docs, release notes, dependencies, permissions, credentials, deletion behavior, generated content, or local file changes when relevant
  • I reviewed the final diff for unrelated changes and suspicious dependency changes
  • I am targeting dev, and my PR title and commit messages use Conventional Commits in English

Maintainer labeling request: please add appropriate type, scope, and priority labels if needed.

Summary by CodeRabbit

  • Chores
    • Updated release checklist to reflect versioned installer asset filenames for macOS and Windows downloads, ensuring post-release verification processes align with current release naming conventions.

@coderabbitai

coderabbitai Bot commented May 2, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: c337ea87-17fc-477e-a0f3-0a7a12464154

📥 Commits

Reviewing files that changed from the base of the PR and between a689708 and 976228a.

📒 Files selected for processing (1)
  • .github/RELEASE_CHECKLIST.md

📝 Walkthrough

Walkthrough

The release checklist documentation is updated to reference versioned installer asset filenames for macOS (arm64/x64) and Windows (x64), replacing unversioned URLs in the English and Chinese sections, with post-release verification steps adjusted accordingly.

Changes

Release Checklist Versioning

Layer / File(s) Summary
Download Links (English & Chinese)
.github/RELEASE_CHECKLIST.md (lines 31–33, 58–60)
Installer asset URLs updated to include version segment (X.Y.Z) in filenames: pawwork-mac-arm64-X.Y.Z.dmg, pawwork-mac-x64-X.Y.Z.dmg, pawwork-win-x64-X.Y.Z.exe in both English "Downloads" and Chinese "下载" sections.
Post-Release Verification
.github/RELEASE_CHECKLIST.md (lines 136–141)
Expected installer asset filenames updated to versioned forms; updater .zip/.blockmap and latest*.yml verification checks remain otherwise consistent with the new asset naming convention.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

documentation, P3, harness

Poem

🐰 A checklist grows with version marks so clear,
arm64, x64, and Windows gear,
From .dmg to X.Y.Z.dmg we rise,
Releases tracked with careful eyes!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(release): use versioned asset names' clearly and concisely describes the primary change—updating the release checklist to use versioned asset names for the release process documentation.
Description check ✅ Passed The pull request description comprehensively follows the template with all major sections completed: Summary, Why, Related Issue, Human Review Status, Review Focus, Risk Notes, How To Verify, Screenshots, and Checklist all properly filled out with relevant details.
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 pawwork/release-checklist-versioned-assets

Review rate limit: 9/10 reviews remaining, refill in 6 minutes.

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

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the .github/RELEASE_CHECKLIST.md file to include version placeholders (-X.Y.Z) in the filenames of the release assets across the download links and verification checklist. I have no feedback to provide.

@Astro-Han
Astro-Han merged commit 51bbc2f into dev May 2, 2026
27 of 28 checks passed
@Astro-Han
Astro-Han deleted the pawwork/release-checklist-versioned-assets branch May 11, 2026 07:57
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