-
Notifications
You must be signed in to change notification settings - Fork 46
docs: Document SHA-256 checksum verification for the runpodctl install script and self-update #709
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
cebe3a9
bda3e4a
da5a75d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| --- | ||
|
Check warning on line 1 in runpodctl/reference/runpodctl-update.mdx
|
||
| title: "update" | ||
| sidebarTitle: "update" | ||
| --- | ||
|
|
||
| Update `runpodctl` to the latest version to access new features and bug fixes. | ||
|
|
||
| <RequestExample> | ||
| ```bash Command | ||
|
|
@@ -13,7 +13,7 @@ | |
|
|
||
| ## Description | ||
|
|
||
| The `update` command downloads and installs the latest version of `runpodctl`. After updating, verify the installation with [`runpodctl version`](/runpodctl/reference/runpodctl-version). | ||
| The `update` command downloads the latest version of `runpodctl` and verifies it against its SHA-256 checksum before replacing the installed binary. Verification always runs. If it fails, the update aborts and leaves your existing binary in place. After updating, verify the installation with [`runpodctl version`](/runpodctl/reference/runpodctl-version). | ||
|
Check warning on line 16 in runpodctl/reference/runpodctl-update.mdx
|
||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. PR #303 added self-update checksum verification in cmd/update.go: the update command downloads the release archive and its checksums_<version>_sha256.txt asset (via DownloadBytes/findAsset), then calls verifyArchiveChecksum (verifyFileChecksum, using stdlib crypto/sha256) before extracting/installing the new binary. Verification always runs (no flag or env var to skip it); on failure (missing checksum asset, malformed digest, or mismatch) the update returns an error before the existing binary is replaced. Source: https://github.com/runpod/runpodctl/blob/c05a2bb71b5cf736b0477e0531f66027dc88cfc6/cmd/update.go#L289 |
||
|
|
||
| ## Related commands | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Line 44)
PR #303 added SHA-256 checksum verification to
install.shbefore extraction; itscalculate_sha256helper usessha256sumorshasumand fails closed with "No SHA-256 checksum tool found" when neither is present, and the new header requirement notessha256sumon Linux orshasumon macOS. This note documents that new prerequisite.Source: runpod/runpodctl#303