yard-timekeeper: Stop YARD Timestamp Churn in Checked-In Docs
The article discusses the release of yard-timekeeper v0.1.0, a RubyGem designed to reduce unnecessary timestamp churn in YARD-generated documentation. This tool helps maintain cleaner version control by restoring files that only have timestamp changes, thus preserving meaningful documentation edits. It aims to streamline the documentation process for Ruby projects while minimizing build noise in version control systems.
- ▪Yard-timekeeper v0.1.0 is a RubyGem that addresses timestamp churn in YARD documentation.
- ▪The tool restores files with only timestamp changes, keeping real content changes intact.
- ▪It is intended to improve the review process by reducing noise in pull requests.
Opening excerpt (first ~120 words) tap to expand
try { if(localStorage) { let currentUser = localStorage.getItem('current_user'); if (currentUser) { currentUser = JSON.parse(currentUser); if (currentUser.id === 561326) { document.getElementById('article-show-container').classList.add('current-user-is-article-author'); } } } } catch (e) { console.error(e); } Peter H. Boling Posted on May 24 yard-timekeeper: Stop YARD Timestamp Churn in Checked-In Docs #ruby #rubygem #yard #opensource 🕰️ I just released yard-timekeeper v0.1.0, a small RubyGem for Ruby projects that check generated YARD HTML into git. It solves a very specific kind of documentation noise: timestamp-only churn. The Problem If your project publishes generated YARD documentation from a checked-in docs/ directory, you have probably seen this: You run the docs task.
…
Excerpt limited to ~120 words for fair-use compliance. The full article is at DEV.to (Top).
Discussion
0 commentsMore from DEV.to (Top)
