0.0
The project is in a healthy, maintained state
๐Ÿ•ฐ๏ธ A YARD plugin that post-processes generated docs, detects timestamp-only diffs in tracked HTML files under docs/, and restores those files from git to prevent pointless churn while keeping the footer timestamp on genuinely changed pages.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 3.0, >= 3.0.6
~> 1.0, >= 1.0.3
~> 2.0, >= 2.0.0
~> 13.0
~> 1.0, >= 1.0.4
~> 1.0, >= 1.0.3

Runtime

~> 1.1, >= 1.1.9
 Project Readme

Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0 ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5 yard-timekeeper Logo by Aboling0, CC BY-SA 4.0

๐Ÿ•ฐ๏ธ Yard::Timekeeper

Version GitHub tag (latest SemVer) License: MIT Downloads Rank CodeCov Test Coverage Coveralls Test Coverage QLTY Test Coverage QLTY Maintainability CI Heads CI Runtime Dependencies @ HEAD CI Current CI Truffle Ruby CI JRuby Deps Locked Deps Unlocked CI Test Coverage CI Style CodeQL Apache SkyWalking Eyes License Compatibility Check

if ci_badges.map(&:color).detect { it != "green"} โ˜๏ธ let me know, as I may have missed the discord notification.


if ci_badges.map(&:color).all? { it == "green"} ๐Ÿ‘‡๏ธ send money so I can do more of this. FLOSS maintenance is now my full-time job.

OpenCollective Backers OpenCollective Sponsors Sponsor Me on Github Liberapay Goal Progress Donate on PayPal Buy me a coffee Donate on Polar Donate at ko-fi.com

๐Ÿ‘ฃ How will this project approach the September 2025 hostile takeover of RubyGems? ๐Ÿš‘๏ธ

I've summarized my thoughts in this blog post.

๐ŸŒป Synopsis

yard-timekeeper keeps checked-in YARD HTML stable by restoring files whose only change is the generated footer timestamp.

Just the important bits:

  • It postprocesses generated docs/**/*.html files after YARD finishes.
  • It only restores files that are already tracked in git and only when the diff is timestamp-only.
  • Real content changes are preserved.
  • The supported workflow is rake yard; raw yard / bin/yard does not run the explicit postprocess hook.

๐Ÿ’ก Info you can shake a stick at

Tokens to Remember Gem name Gem namespace
Works with JRuby JRuby current Compat JRuby HEAD Compat
Works with Truffle Ruby Truffle Ruby 24.2 Compat Truffle Ruby 25.0 Compat Truffle Ruby current Compat
Works with MRI Ruby 4 Ruby 4.0 Compat Ruby current Compat Ruby HEAD Compat
Works with MRI Ruby 3 Ruby 3.2 Compat Ruby 3.3 Compat Ruby 3.4 Compat
Support & Community Join Me on Daily.dev's RubyFriends Live Chat on Discord Get help from me on Upwork Get help from me on Codementor
Source Source on GitLab.com Source on CodeBerg.org Source on Github.com The best SHA: dQw4w9WgXcQ!
Documentation Current release on RubyDoc.info YARD on Galtzo.com Maintainer Blog GitLab Wiki GitHub Wiki
Compliance License: MIT Apache license compatibility: Category A ๐Ÿ“„ilo-declaration-img Security Policy Contributor Covenant 2.1 SemVer 2.0.0
Style Enforced Code Style Linter Keep-A-Changelog 1.0.0 Gitmoji Commits Compatibility appraised by: appraisal2
Maintainer ๐ŸŽ–๏ธ Follow Me on LinkedIn Follow Me on Ruby.Social Follow Me on Bluesky Contact Maintainer My technical writing
... ๐Ÿ’– Find Me on WellFound: Find Me on CrunchBase My LinkTree More About Me ๐ŸงŠ ๐Ÿ™ ๐Ÿ›– ๐Ÿงช

Compatibility

Compatible with MRI Ruby 3.2.0+, and concordant releases of JRuby, and TruffleRuby.

๐Ÿšš Amazing test matrix was brought to you by ๐Ÿ”Ž appraisal2 ๐Ÿ”Ž and the color ๐Ÿ’š green ๐Ÿ’š
๐Ÿ‘Ÿ Check it out! โœจ github.com/appraisal-rb/appraisal2 โœจ

Federated DVCS

Find this repo on federated forges (Coming soon!)
Federated DVCS Repository Status Issues PRs Wiki CI Discussions
๐Ÿงช galtzo-floss/yard-timekeeper on GitLab The Truth ๐Ÿ’š ๐Ÿ’š ๐Ÿ’š ๐Ÿญ Tiny Matrix โž–
๐ŸงŠ galtzo-floss/yard-timekeeper on CodeBerg An Ethical Mirror (Donate) ๐Ÿ’š ๐Ÿ’š โž– โญ•๏ธ No Matrix โž–
๐Ÿ™ galtzo-floss/yard-timekeeper on GitHub Another Mirror ๐Ÿ’š ๐Ÿ’š ๐Ÿ’š ๐Ÿ’ฏ Full Matrix ๐Ÿ’š
๐ŸŽฎ๏ธ Discord Server Live Chat on Discord Let's talk about this library!

Enterprise Support Tidelift

Available as part of the Tidelift Subscription.

Need enterprise-level guarantees?

The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.

Get help from me on Tidelift

  • ๐Ÿ’กSubscribe for support guarantees covering all your 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:

  • Live Chat on Discord
  • Get help from me on Upwork
  • Get help from me on Codementor

โœจ Installation

Install the gem and add to the application's Gemfile by executing:

bundle add yard-timekeeper

If bundler is not being used to manage dependencies, install the gem by executing:

gem install yard-timekeeper

โš™๏ธ Configuration

No .yardopts entry is required when you wire yard-timekeeper through the rake integration. In fact, --plugin timekeeper should be removed from .yardopts for this workflow:

require "yard/timekeeper"

Yard::Timekeeper.install_rake_tasks!(:yard)

yard-timekeeper runs after YARD generates HTML and checks git diffs for tracked files under docs/. If a file's only change is the footer line:

Generated on ...

then the plugin restores that file from git so the docs site does not churn for timestamp-only changes.

Notes:

  • It only affects files already tracked in git.
  • It is most useful for checked-in docs/ sites.
  • Files with any real content changes keep their fresh timestamp.

Environment toggles:

  • YARD_TIMEKEEPER_DISABLE=true โ€” disable the post-process entirely

๐Ÿ”ง Basic Usage

Generate docs through rake so the postprocess runs after YARD finishes:

bin/rake yard

If your project also exposes bin/yard, do not rely on it for the full docs workflow. It runs YARD, but it does not run Yard::Timekeeper.install_rake_tasks!(:yard).

For checked-in docs, the recommended setup is:

--plugin fence
--plugin yaml

๐Ÿฆท 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. 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

Support us with a monthly donation and help us continue our activities. [Become a backer]

NOTE: kettle-readme-backers updates this list every day, automatically.

No backers yet. Be the first!

Open Collective for Organizations

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

NOTE: kettle-readme-backers updates this list every day, automatically.

No sponsors yet. Be the first!

Another way to support open-source

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. 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

OpenCollective Backers OpenCollective Sponsors Sponsor Me on Github Liberapay Goal Progress Donate on PayPal Buy me a coffee Donate on Polar Donate to my FLOSS efforts at ko-fi.com Donate to my FLOSS efforts using Patreon

๐Ÿ” 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 issues or PRs, or use the gem and think about how it could be better.

We Keep A Changelog so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

๐Ÿš€ Release Instructions

See CONTRIBUTING.md.

Code Coverage

Coverage service badges

Coverage Graph

Coveralls Test Coverage

QLTY Test Coverage

๐Ÿช‡ Code of Conduct

Everyone interacting with this project's codebases, issue trackers, chat rooms and mailing lists agrees to follow the Contributor Covenant 2.1.

๐ŸŒˆ Contributors

Contributors

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/galtzo-floss/yard-timekeeper/-/graphs/main

โญ๏ธ Star History Star History Chart

๐Ÿ“Œ Versioning

This library follows Semantic Versioning 2.0.0 for its public API where practical. For most applications, prefer the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("yard-timekeeper", "~> 0.0")
๐Ÿ“Œ Is "Platform Support" part of the public API? More details inside.

Dropping support for a platform can be a breaking change for affected users. If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.

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: MIT.

ยฉ Copyright

See LICENSE.md for the official copyright notice.

Copyright holders
  • Copyright (c) 2026 Peter H. Boling

๐Ÿค‘ A request for help

Maintainers have teeth and need to pay their dentists. After getting laid off in an RIF in March, and encountering difficulty finding a new one, I began spending most of my time 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 join the community or get help ๐Ÿ‘‡๏ธ Join the Discord.

Live Chat on Discord

To say "thanks!" โ˜๏ธ Join the Discord or ๐Ÿ‘‡๏ธ send money.

Sponsor galtzo-floss/yard-timekeeper on Open Source Collective ๐Ÿ’Œ Sponsor me on GitHub Sponsors ๐Ÿ’Œ Sponsor me on Liberapay ๐Ÿ’Œ Donate on PayPal

Please give the project a star โญ โ™ฅ.

Thanks for RTFM. โ˜บ๏ธ

Field Value
Package yard-timekeeper
Description ๐Ÿ•ฐ๏ธ A YARD plugin that post-processes generated docs, detects timestamp-only diffs in tracked HTML files under docs/, and restores those files from git to prevent pointless churn while keeping the footer timestamp on genuinely changed pages.
Homepage https://github.com/galtzo-floss/yard-timekeeper
Source https://github.com/galtzo-floss/yard-timekeeper/tree/v0.1.0
License MIT
Funding https://github.com/sponsors/pboling, https://issuehunt.io/u/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/galtzo-floss, https://patreon.com/galtzo, https://polar.sh/pboling, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/yard-timekeeper, https://www.buymeacoffee.com/pboling