Skip to content

Add stable latest-release download asset names - #231

Open
hayaa wants to merge 1 commit into
masterfrom
add-stable-release-asset-names
Open

hayaa wants to merge 1 commit into
masterfrom
add-stable-release-asset-names

Conversation

@hayaa

@hayaa hayaa commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Context

Docs and install instructions cannot permalink a specific GitHub Release binary, because artifacts are named cx-<version>-<target>. GitHub's /releases/latest/download/<filename> lookup requires that exact filename on the newest non-prerelease. This change attaches a second, unversioned copy of each archive so those URLs stay valid across versions.

Linked Issues

N/A — requested as a docs/release-workflow improvement, no ticket.

Design

The existing Release workflow still builds and uploads versioned archives (cx-0.1.24-x86_64-apple-darwin.tar.gz, etc.). After packaging, it copies each archive to cx-<target>.tar.gz / .zip. action-gh-release already uploads artifacts/*, and checksum generation already globs cx-*, so both names land on the GitHub Release and in checksums-sha256.txt. Docs point at /releases/latest/download/cx-<target>.*. Homebrew, crates.io, and install.sh keep using versioned names/tags.

Key Decisions

  • Duplicate assets instead of renaming or introducing a moving latest git tag. Renaming would break Homebrew pins and install.sh; a latest tag fights verify-version (tag must match Cargo.toml) and git history.
  • Leave install.sh version-resolved so CX_VERSION= pinning still works. Unversioned checksum lines are extra; looking up the full versioned filename does not collide.

Changes

  • Each GitHub Release will include unversioned platform archives alongside the versioned ones.
  • Quick start and installation reference link to /releases/latest/download/... instead of cx-<version>-... on the releases index.

Testing

  • Inspected the workflow diff and confirmed checksums already glob cx-*.
  • Did not run the Release workflow (tag-triggered; would publish crates.io).
  • Did not upload unversioned files onto the existing v0.1.24 GitHub Release.

Risks & Rollout

Additive only: existing versioned asset names, Homebrew, cargo install, and install.sh are unchanged. Permalink URLs 404 until unversioned files exist on the current latest release — either a one-off gh release upload to v0.1.24, or the next tagged release after this merges. Rollback is revert of this PR (future releases stop attaching the extra names; already-uploaded assets on an old tag remain).

Out of Scope / Follow-ups

  • One-off backfill of unversioned assets onto the published v0.1.24 release (gh release upload; do not re-run the full Release workflow, it would cargo publish again).
  • Switching install.sh to unversioned /latest/download URLs.

Made with Cursor

@hayaa
hayaa requested review from a team as code owners September 16, 2026 04:51
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 16, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-16T04:55:02.392953Z b12d8ac PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

GitHub's /releases/latest/download lookup uses the exact asset filename, so versioned archives cannot be linked from docs without updating them each release.

Co-authored-by: Cursor <cursoragent@cursor.com>
@hayaa
hayaa force-pushed the add-stable-release-asset-names branch from b12d8ac to e5d7ae7 Compare September 16, 2026 04:53

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b12d8ac595

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/configuration.md
Comment on lines +504 to +508
- [macOS Intel](https://github.com/coralogix/cx-cli/releases/latest/download/cx-x86_64-apple-darwin.tar.gz)
- [macOS Apple silicon](https://github.com/coralogix/cx-cli/releases/latest/download/cx-aarch64-apple-darwin.tar.gz)
- [Linux x86_64](https://github.com/coralogix/cx-cli/releases/latest/download/cx-x86_64-unknown-linux-musl.tar.gz)
- [Linux aarch64](https://github.com/coralogix/cx-cli/releases/latest/download/cx-aarch64-unknown-linux-musl.tar.gz)
- [Windows](https://github.com/coralogix/cx-cli/releases/latest/download/cx-x86_64-pc-windows-msvc.zip)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Backfill stable assets before publishing direct links

If these docs deploy before the next tagged release, the five new archive links return 404 because the Package steps in .github/workflows/release.yml create the unversioned assets only for future workflow runs, while the existing latest release was not backfilled. This immediately regresses the previously working Releases-page instructions, including the primary Windows download path; upload these aliases to the current release before publishing the links, or retain the old links until a release containing them becomes latest.

Useful? React with 👍 / 👎.

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