Skip to content

fix: docs how-to verify releases (since v26.09.0) - #959

Open
jdlcdl wants to merge 4 commits into
selfcustody:developfrom
jdlcdl:docs_verify_release
Open

jdlcdl wants to merge 4 commits into
selfcustody:developfrom
jdlcdl:docs_verify_release

Conversation

@jdlcdl

@jdlcdl jdlcdl commented Oct 8, 2026 •

Copy link
Copy Markdown
Member

What is this PR for?

Docs never got updated prior to last release for "how-to verify release v26.09.0".
This pr brings "develop" up to date with how I expect future releases to be verified (similar to latest). Targeting "develop" because the ATTESTATION.txt asset included in last release explains the same.

re: notTanveer's feedback:

  • CONTRIBUTIONS.md have corrected -- yet less detail about releases.
  • sign_release.py updated to current release layout. Also allows interrupting at each-step -- writes of: compressed release zip, SHA256SUMS file, and all DER signature files -- so that it can be run interactively and/or restarted. I wasn't aware of this script for release v26.09.0. I'd added CHANGELOG.md and SHA256SUMS as described in the release attestation asset... and this is where I would have needed to be able to append to the release interactively.

TODO:
[ ] Krux docs that explain krux-installer to be updated (no download or verification sections since releases are embedded in krux-installer).

Changes made to:

  • Code
  • Tests
  • Docs
  • CHANGELOG

Did you build the code and tested on device?

  • Yes, build and tested on

What is the purpose of this pull request?

  • Bug fix
  • New feature
  • Docs update
  • Other

@codecov

codecov Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.60%. Comparing base (2937a29) to head (7d5fcee).
⚠️ Report is 8 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #959   +/-   ##
========================================
  Coverage    97.60%   97.60%           
========================================
  Files           84       84           
  Lines        10994    10994           
========================================
  Hits         10731    10731           
  Misses         263      263           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jdlcdl
jdlcdl force-pushed the docs_verify_release branch from 8c21cac to 8981b20 Compare October 8, 2026 19:04
@notTanveer

Copy link
Copy Markdown
Contributor

i can see old layout still described elsewhere:

  • CONTRIBUTING.md, 199 - 201
  • docs/getting-started/installing/from-gui/usage.en.md, 154,168 still say zip.sha256.txt
  • sign_release.py,161 still writes .sha256.txt and .sig.

@jdlcdl
jdlcdl marked this pull request as draft October 9, 2026 19:25
@jdlcdl
jdlcdl force-pushed the docs_verify_release branch from 87d46de to 4f54c70 Compare October 9, 2026 20:11
@jdlcdl

jdlcdl commented Nov 16, 2026

Copy link
Copy Markdown
Member Author

Thanks tanveer.

Reopening this PR so that it makes next release.

  • CONTRIBUTING.md, 199 - 201
    ...is addressed in 466a362
  • sign_release.py,161 still writes .sha256.txt and .sig.
    ...is addressed in 4f54c70

@jdlcdl
jdlcdl marked this pull request as ready for review November 16, 2026 10:28
@jdlcdl jdlcdl added the prioritized Prioritized focus for near-term merge label Nov 16, 2026

@qlrd qlrd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ACK 7d5fcee

@joaozinhom joaozinhom left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ACK 7d5fcee


Alternatively, the *GPG signature file* `SHA256SUMS.asc` can be verified for Krux contributors -- if they have also signed a pre-built release:
```bash
gpg --verify SHA256SUMS.asc SHA256SUMS

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this is what i got while testing.

~/verify959 ❯ gpg --verify SHA256SUMS.asc SHA256SUMS
gpg: keybox '/home/sahil/verify959/gnupg/pubring.kbx' created
gpg: Signature made Sun 13 Sep 2026 03:01:51 AM IST
gpg:                using EDDSA key 6DC76DC81B5C35D7F432712945D7F41053AF05F3
gpg: Can't check signature: No public key
[ble: exit 2]

should we add your key here? or let the user find out? wdyt @jdlcdl ?

Suggested change
gpg --verify SHA256SUMS.asc SHA256SUMS
# one time: import the maintainer key (jdlcdl)
curl -sL https://github.com/jdlcdl.gpg | gpg --import
gpg --verify SHA256SUMS.asc SHA256SUMS

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I would prefer that if they want to find my sig, they don't follow a link they saw, that they reach it by searching themselves... maybe also for next maintatiner too (so inidividual is not in docs... it will be in release notes).

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

prioritized Prioritized focus for near-term merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants