๐ฟ StoneChecksums - Generate SHA-256 and SHA-512 checksums of a RubyGem
If โ๏ธ ci_badges.map(&:color).detect { it != "green"}
let me know, as I may have missed the discord notification.
OTOH, if ci_badges.map(&:color).all? { it == "green"}
๐๏ธ send money so I can do more of this. FLOSS is now my full-time job.
๐ป Synopsis
Generate SHA-256 and SHA-512 checksums of a rubygem library, and commit them to your repository. The SHA-256 will match the shown for each gem published to RubyGems.org.
# as a rake task:
bundle exec rake build:generate_checksums
# as a binstub:
bin/generate_checksums
๐ก Info you can shake a stick at
Federated DVCS
Federated DVCS Repository | Status | Issues | PRs | Wiki | CI | Discussions |
---|---|---|---|---|---|---|
๐งช kettle-rb/kettle-dev on GitLab | The Truth | ๐ | ๐ | ๐ | ๐ Tiny Matrix | โ |
๐ง kettle-rb/kettle-dev on CodeBerg | An Ethical Mirror (Donate) | ๐ | ๐ | โ | โญ๏ธ No Matrix | โ |
๐ kettle-rb/kettle-dev on GitHub | Another Mirror | ๐ | ๐ | โ | ๐ฏ Full Matrix | ๐ |
๐ฎ๏ธ Discord Server | Let's | talk | about | this | library! |
- ๐กSubscribe for support guarantees covering all FLOSS dependencies
- ๐กTidelift is part of Sonar
- ๐กTidelift pays maintainers to maintain the software you depend on!
๐@
Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers
Alternatively:
Tokens to Remember |
|
---|---|
Works with JRuby |
|
Works with Truffle Ruby |
|
Works with MRI Ruby 3 |
|
Works with MRI Ruby 2 |
|
Works with MRI Ruby 1 | |
Source |
|
Documentation |
|
Compliance |
|
Style |
|
Support |
|
Maintainer ๐๏ธ |
|
... ๐ |
|
โจ Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add stone_checksums
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install stone_checksums
๐ Secure Installation
This gem is cryptographically signed, and has verifiable SHA-256 and SHA-512 checksums by stone_checksums. Be sure the gem you install hasnโt been tampered with by following the instructions below.
Add my public key (if you havenโt already, expires 2045-04-29) as a trusted certificate:
gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
You only need to do that once. Then proceed to install with:
gem install stone_checksums -P HighSecurity
The HighSecurity
trust profile will verify signed gems, and not allow the installation of unsigned dependencies.
If you want to up your security game full-time:
bundle config set --global trust-policy MediumSecurity
MediumSecurity
instead of HighSecurity
is necessary if not all the gems you use are signed.
NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
โ๏ธ Configuration
Configuration env vars:
- GEM_CHECKSUMS_CHECKSUMS_DIR: Where to write checksum files (default: checksums)
- GEM_CHECKSUMS_PACKAGE_DIR: Where to look for built gems (default: pkg)
- GEM_CHECKSUMS_GIT_DRY_RUN: When true, run a dry-run commit and clean up temporary files
- GEM_CHECKSUMS_ASSUME_YES: When true and Bundler < 2.7.0, proceed without interactive prompt (still requires SOURCE_DATE_EPOCH)
๐ง Basic Usage
Generate Gem Checksums (SHA-256 and SHA-512)
This library helps you generate checksums for your built gem and commit them.
- Bundler >= 2.7.0: No SOURCE_DATE_EPOCH needed. Bundler now uses a constant timestamp internally, making builds reproducible by default.
- Bundler < 2.7.0: You must set SOURCE_DATE_EPOCH before building the gem to get deterministic checksums, or upgrade Bundler.
- If you still want to proceed on old Bundler non-interactively, set GEM_CHECKSUMS_ASSUME_YES=true (SOURCE_DATE_EPOCH is still required).
Usage via Rake (recommended):
bundle exec rake build
bundle exec rake build:generate_checksums
Usage via CLI (equivalent):
bin/gem_checksums [pkg/your_gem-1.2.3.gem]
Public API (YARD)
- Module StoneChecksums (primary namespace)
- ::install_tasks() -> void โ loads Rake tasks (delegates to GemChecksums.install_tasks)
- ::generate(git_dry_run: Boolean = false) -> void โ generate SHA-256/512 checksums and commit (delegates to GemChecksums.generate)
- Error < GemChecksums::Error โ error class hierarchy is preserved
- Version::VERSION: String โ current gem version
- Module GemChecksums (deprecated, backward-compatible namespace)
- ::install_tasks() -> void โ identical behavior
- ::generate(git_dry_run: Boolean = false) -> void โ identical behavior
- Error โ base error class used internally
- Version::VERSION: String โ same as StoneChecksums::Version::VERSION
See the generated YARD docs for full details: Current release on RubyDoc.info.
๐ฆท FLOSS Funding
While galtzo-floss tools are free software and will always be, the project would benefit immensely from some funding. Raising a monthly budget of... "dollars" would make the project more sustainable.
We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account for your preferences (although currently Open Collective is our preferred funding platform).
If you're working in a company that's making significant use of galtzo-floss tools we'd appreciate it if you suggest to your company to become a galtzo-floss sponsor.
You can support the development of galtzo-floss tools via GitHub Sponsors, Liberapay, PayPal, Open Collective and Tidelift.
๐ NOTE |
---|
If doing a sponsorship in the form of donation is problematic for your company from an accounting standpoint, we'd recommend the use of Tidelift, where you can get a support-like subscription instead. |
Open Collective for Individuals
No backers yet. Be the first!
Support us with a monthly donation and help us continue our activities. [Become a backer]
Open Collective for Organizations
No sponsors yet. Be the first!
Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]
Another way to support open-source
How wonderful it is that nobody need wait a single moment before starting to improve the world.
โAnne Frank
Iโm driven by a passion to foster a thriving open-source community โ a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions โ totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. I was recently affected by layoffs, and the tech jobs market is unwelcoming. Iโm reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 ๐ chickens, 2 ๐ถ dogs, 3 ๐ฐ rabbits, 8 ๐โ cats).
If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund
.
Iโm developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
Floss-Funding.dev: ๐๏ธ No network calls. ๐๏ธ No tracking. ๐๏ธ No oversight. ๐๏ธ Minimal crypto hashing. ๐ก Easily disabled nags
๐ Security
See SECURITY.md.
๐ค Contributing
If you need some ideas of where to help, you could work on adding more code coverage, or if it is already ๐ฏ (see below) check reek, issues, or PRs, or use the gem and think about how it could be better.
We so if you make changes, remember to update it.
See CONTRIBUTING.md for more detailed instructions.
๐ Release Instructions
See CONTRIBUTING.md.
Code Coverage
๐ช Code of Conduct
Everyone interacting with this project's codebases, issue trackers,
chat rooms and mailing lists agrees to follow the .
๐ Contributors
Made with contributors-img.
Also see GitLab Contributors: https://gitlab.com/galtzo-floss/stone_checksums/-/graphs/main
๐ Versioning
This Library adheres to .
Violations of this scheme should be reported as bugs.
Specifically, if a minor or patch version is released that breaks backward compatibility,
a new version should be immediately released that restores compatibility.
Breaking changes to the public API will only be introduced with new major versions.
dropping support for a platform is both obviously and objectively a breaking change
โJordan Harband (@ljharb, maintainer of SemVer) in SemVer issue 716
I understand that policy doesn't work universally ("exceptions to every rule!"), but it is the policy here. As such, in many cases it is good to specify a dependency on this library using the Pessimistic Version Constraint with two digits of precision.
For example:
spec.add_dependency("stone_checksums", "~> 1.0")
SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms is a breaking change to an API. It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.
To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:
See CHANGELOG.md for a list of releases.
๐ License
The gem is available as open source under the terms of
the MIT License .
See LICENSE.txt for the official Copyright Notice.
ยฉ Copyright
-
Copyright (c) 2023, 2025 Peter H.ย Boling, of
Galtzo.com
, and stone_checksums contributors.
๐ค A request for help
Maintainers have teeth, and need to pay their dentists. After getting laid off in an RIF in March, and filled with many dozens of rejections, I'm now spending ~80 hours a week building open source tools. I'm hoping to be able to pay for my kids' health insurance this month, so if you value the work I am doing, I need your support. Please consider sponsoring me or the project.
To say "thanks for maintaining such a great tool" ๐๏ธ Join the Discord or โ๏ธ send money.
To join the community or get help ๐๏ธ Join the Discord.
Please give the project a star โญ โฅ.
Thanks for RTFM. โบ๏ธ