yard-timekeeper 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +46 -0
- data/CITATION.cff +20 -0
- data/CODE_OF_CONDUCT.md +134 -0
- data/CONTRIBUTING.md +235 -0
- data/FUNDING.md +74 -0
- data/LICENSE.md +10 -0
- data/README.md +544 -0
- data/RUBOCOP.md +71 -0
- data/SECURITY.md +21 -0
- data/certs/pboling.pem +27 -0
- data/lib/yard/timekeeper/version.rb +10 -0
- data/lib/yard/timekeeper.rb +135 -0
- data/lib/yard-timekeeper.rb +7 -0
- data/sig/yard/timekeeper/version.rbs +9 -0
- data/sig/yard/timekeeper.rbs +6 -0
- data.tar.gz.sig +0 -0
- metadata +292 -0
- metadata.gz.sig +0 -0
data/README.md
ADDED
|
@@ -0,0 +1,544 @@
|
|
|
1
|
+
[![Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-floss-i]][🖼️galtzo-floss] [![ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5][🖼️ruby-lang-i]][🖼️ruby-lang] [![yard-timekeeper Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-floss-yard-timekeeper-i]][🖼️galtzo-floss-yard-timekeeper]
|
|
2
|
+
|
|
3
|
+
[🖼️galtzo-floss-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
|
|
4
|
+
[🖼️galtzo-floss]: https://discord.gg/3qme4XHNKN
|
|
5
|
+
[🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-192px.svg
|
|
6
|
+
[🖼️ruby-lang]: https://www.ruby-lang.org/
|
|
7
|
+
[🖼️galtzo-floss-yard-timekeeper-i]: https://logos.galtzo.com/assets/images/galtzo-floss/yard-timekeeper/avatar-192px.svg
|
|
8
|
+
[🖼️galtzo-floss-yard-timekeeper]: https://github.com/galtzo-floss/yard-timekeeper
|
|
9
|
+
|
|
10
|
+
# 🕰️ Yard::Timekeeper
|
|
11
|
+
|
|
12
|
+
[![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
|
|
13
|
+
|
|
14
|
+
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][🖼️galtzo-floss], as I may have missed the [discord notification][🖼️galtzo-floss].
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
`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.
|
|
19
|
+
|
|
20
|
+
[![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate at ko-fi.com][🖇kofi-img]][🖇kofi]
|
|
21
|
+
|
|
22
|
+
<details>
|
|
23
|
+
<summary>👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️</summary>
|
|
24
|
+
|
|
25
|
+
I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).
|
|
26
|
+
|
|
27
|
+
</details>
|
|
28
|
+
|
|
29
|
+
## 🌻 Synopsis
|
|
30
|
+
|
|
31
|
+
`yard-timekeeper` keeps checked-in YARD HTML stable by restoring files whose
|
|
32
|
+
only change is the generated footer timestamp.
|
|
33
|
+
|
|
34
|
+
Just the important bits:
|
|
35
|
+
|
|
36
|
+
- It postprocesses generated `docs/**/*.html` files after YARD finishes.
|
|
37
|
+
- It only restores files that are already tracked in git and only when the diff
|
|
38
|
+
is timestamp-only.
|
|
39
|
+
- Real content changes are preserved.
|
|
40
|
+
- The supported workflow is `rake yard`; raw `yard` / `bin/yard` does not run
|
|
41
|
+
the explicit postprocess hook.
|
|
42
|
+
|
|
43
|
+
## 💡 Info you can shake a stick at
|
|
44
|
+
|
|
45
|
+
| Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
|
|
46
|
+
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
47
|
+
| Works with JRuby | [![JRuby current Compat][💎jruby-c-i]][🚎10-j-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf]|
|
|
48
|
+
| Works with Truffle Ruby | [![Truffle Ruby 24.2 Compat][💎truby-24.2i]][🚎truby-24.2-wf] [![Truffle Ruby 25.0 Compat][💎truby-25.0i]][🚎truby-25.0-wf] [![Truffle Ruby current Compat][💎truby-c-i]][🚎9-t-wf]|
|
|
49
|
+
| Works with MRI Ruby 4 | [![Ruby 4.0 Compat][💎ruby-4.0i]][🚎11-c-wf] [![Ruby current Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf]|
|
|
50
|
+
| Works with MRI Ruby 3 | [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎ruby-3.2-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎ruby-3.3-wf] [![Ruby 3.4 Compat][💎ruby-3.4i]][🚎ruby-3.4-wf]|
|
|
51
|
+
| Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork] [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor] |
|
|
52
|
+
| Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on Github.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc] |
|
|
53
|
+
| Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![GitLab Wiki][📜gl-wiki-img]][📜gl-wiki] [![GitHub Wiki][📜gh-wiki-img]][📜gh-wiki] |
|
|
54
|
+
| Compliance | [![License: MIT][📄license-img]][📄license] [![Apache license compatibility: Category A][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
|
|
55
|
+
| Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2] |
|
|
56
|
+
| Maintainer 🎖️ | [![Follow Me on LinkedIn][💖🖇linkedin-img]][💖🖇linkedin] [![Follow Me on Ruby.Social][💖🐘ruby-mast-img]][💖🐘ruby-mast] [![Follow Me on Bluesky][💖🦋bluesky-img]][💖🦋bluesky] [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact] [![My technical writing][💖💁🏼♂️devto-img]][💖💁🏼♂️devto] |
|
|
57
|
+
| `...` 💖 | [![Find Me on WellFound:][💖✌️wellfound-img]][💖✌️wellfound] [![Find Me on CrunchBase][💖💲crunchbase-img]][💖💲crunchbase] [![My LinkTree][💖🌳linktree-img]][💖🌳linktree] [![More About Me][💖💁🏼♂️aboutme-img]][💖💁🏼♂️aboutme] [🧊][💖🧊berg] [🐙][💖🐙hub] [🛖][💖🛖hut] [🧪][💖🧪lab] |
|
|
58
|
+
|
|
59
|
+
### Compatibility
|
|
60
|
+
|
|
61
|
+
Compatible with MRI Ruby 3.2.0+, and concordant releases of JRuby, and TruffleRuby.
|
|
62
|
+
|
|
63
|
+
| 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
|
|
64
|
+
|------------------------------------------------|--------------------------------------------------------|
|
|
65
|
+
| 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
### Federated DVCS
|
|
70
|
+
|
|
71
|
+
<details markdown="1">
|
|
72
|
+
<summary>Find this repo on federated forges (Coming soon!)</summary>
|
|
73
|
+
|
|
74
|
+
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
|
|
75
|
+
|-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
|
|
76
|
+
| 🧪 [galtzo-floss/yard-timekeeper on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
|
|
77
|
+
| 🧊 [galtzo-floss/yard-timekeeper on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
|
|
78
|
+
| 🐙 [galtzo-floss/yard-timekeeper on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
|
|
79
|
+
| 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
|
|
80
|
+
|
|
81
|
+
</details>
|
|
82
|
+
|
|
83
|
+
[gh-discussions]: https://github.com/galtzo-floss/yard-timekeeper/discussions
|
|
84
|
+
|
|
85
|
+
### Enterprise Support [](https://tidelift.com/subscription/pkg/rubygems-yard-timekeeper?utm_source=rubygems-yard-timekeeper&utm_medium=referral&utm_campaign=readme)
|
|
86
|
+
|
|
87
|
+
Available as part of the Tidelift Subscription.
|
|
88
|
+
|
|
89
|
+
<details markdown="1">
|
|
90
|
+
<summary>Need enterprise-level guarantees?</summary>
|
|
91
|
+
|
|
92
|
+
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.
|
|
93
|
+
|
|
94
|
+
[![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
|
|
95
|
+
|
|
96
|
+
- 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies
|
|
97
|
+
- 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
|
|
98
|
+
- 💡Tidelift pays maintainers to maintain the software you depend on!<br/>📊`@`Pointy Haired Boss: An [enterprise support][🏙️entsup-tidelift] subscription is "[never gonna let you down][🧮kloc]", and *supports* open source maintainers
|
|
99
|
+
|
|
100
|
+
Alternatively:
|
|
101
|
+
|
|
102
|
+
- [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
103
|
+
- [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork]
|
|
104
|
+
- [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor]
|
|
105
|
+
|
|
106
|
+
</details>
|
|
107
|
+
|
|
108
|
+
## ✨ Installation
|
|
109
|
+
|
|
110
|
+
Install the gem and add to the application's Gemfile by executing:
|
|
111
|
+
|
|
112
|
+
```console
|
|
113
|
+
bundle add yard-timekeeper
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
If bundler is not being used to manage dependencies, install the gem by executing:
|
|
117
|
+
|
|
118
|
+
```console
|
|
119
|
+
gem install yard-timekeeper
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
## ⚙️ Configuration
|
|
123
|
+
|
|
124
|
+
No `.yardopts` entry is required when you wire `yard-timekeeper` through the
|
|
125
|
+
rake integration. In fact, `--plugin timekeeper` should be removed from
|
|
126
|
+
`.yardopts` for this workflow:
|
|
127
|
+
|
|
128
|
+
```ruby
|
|
129
|
+
require "yard/timekeeper"
|
|
130
|
+
|
|
131
|
+
Yard::Timekeeper.install_rake_tasks!(:yard)
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
`yard-timekeeper` runs after YARD generates HTML and checks git diffs for tracked
|
|
135
|
+
files under `docs/`. If a file's only change is the footer line:
|
|
136
|
+
|
|
137
|
+
```text
|
|
138
|
+
Generated on ...
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
then the plugin restores that file from git so the docs site does not churn for
|
|
142
|
+
timestamp-only changes.
|
|
143
|
+
|
|
144
|
+
Notes:
|
|
145
|
+
|
|
146
|
+
- It only affects files already tracked in git.
|
|
147
|
+
- It is most useful for checked-in `docs/` sites.
|
|
148
|
+
- Files with any real content changes keep their fresh timestamp.
|
|
149
|
+
|
|
150
|
+
Environment toggles:
|
|
151
|
+
|
|
152
|
+
- `YARD_TIMEKEEPER_DISABLE=true` — disable the post-process entirely
|
|
153
|
+
|
|
154
|
+
## 🔧 Basic Usage
|
|
155
|
+
|
|
156
|
+
Generate docs through rake so the postprocess runs after YARD finishes:
|
|
157
|
+
|
|
158
|
+
```console
|
|
159
|
+
bin/rake yard
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
If your project also exposes `bin/yard`, do not rely on it for the full docs
|
|
163
|
+
workflow. It runs YARD, but it does not run
|
|
164
|
+
`Yard::Timekeeper.install_rake_tasks!(:yard)`.
|
|
165
|
+
|
|
166
|
+
For checked-in docs, the recommended setup is:
|
|
167
|
+
|
|
168
|
+
```text
|
|
169
|
+
--plugin fence
|
|
170
|
+
--plugin yaml
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## 🦷 FLOSS Funding
|
|
174
|
+
|
|
175
|
+
While galtzo-floss tools are free software and will always be, the project would benefit immensely from some funding.
|
|
176
|
+
Raising a monthly budget of... "dollars" would make the project more sustainable.
|
|
177
|
+
|
|
178
|
+
We welcome both individual and corporate sponsors! We also offer a
|
|
179
|
+
wide array of funding channels to account for your preferences.
|
|
180
|
+
Currently, [Open Collective][🖇osc] is our preferred funding platform.
|
|
181
|
+
|
|
182
|
+
**If you're working in a company that's making significant use of galtzo-floss tools we'd
|
|
183
|
+
appreciate it if you suggest to your company to become a galtzo-floss sponsor.**
|
|
184
|
+
|
|
185
|
+
You can support the development of galtzo-floss tools via
|
|
186
|
+
[GitHub Sponsors][🖇sponsor],
|
|
187
|
+
[Liberapay][⛳liberapay],
|
|
188
|
+
[PayPal][🖇paypal],
|
|
189
|
+
[Open Collective][🖇osc]
|
|
190
|
+
and [Tidelift][🏙️entsup-tidelift].
|
|
191
|
+
|
|
192
|
+
| 📍 NOTE |
|
|
193
|
+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
194
|
+
| If doing a sponsorship in the form of donation is problematic for your company <br/> from an accounting standpoint, we'd recommend the use of Tidelift, <br/> where you can get a support-like subscription instead. |
|
|
195
|
+
|
|
196
|
+
### Open Collective for Individuals
|
|
197
|
+
|
|
198
|
+
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/galtzo-floss#backer)]
|
|
199
|
+
|
|
200
|
+
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
201
|
+
|
|
202
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
|
|
203
|
+
No backers yet. Be the first!
|
|
204
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
|
|
205
|
+
|
|
206
|
+
### Open Collective for Organizations
|
|
207
|
+
|
|
208
|
+
Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/galtzo-floss#sponsor)]
|
|
209
|
+
|
|
210
|
+
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
211
|
+
|
|
212
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
|
|
213
|
+
No sponsors yet. Be the first!
|
|
214
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
|
|
215
|
+
|
|
216
|
+
[kettle-readme-backers]: https://github.com/galtzo-floss/yard-timekeeper/blob/main/exe/kettle-readme-backers
|
|
217
|
+
|
|
218
|
+
### Another way to support open-source
|
|
219
|
+
|
|
220
|
+
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).
|
|
221
|
+
|
|
222
|
+
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`.
|
|
223
|
+
|
|
224
|
+
I’m developing a new library, [floss_funding][🖇floss-funding-gem], 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.
|
|
225
|
+
|
|
226
|
+
**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
|
|
227
|
+
|
|
228
|
+
[![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS efforts using Patreon][🖇patreon-img]][🖇patreon]
|
|
229
|
+
|
|
230
|
+
## 🔐 Security
|
|
231
|
+
|
|
232
|
+
See [SECURITY.md][🔐security].
|
|
233
|
+
|
|
234
|
+
## 🤝 Contributing
|
|
235
|
+
|
|
236
|
+
If you need some ideas of where to help, you could work on adding more code coverage,
|
|
237
|
+
or if it is already 💯 (see [below](#code-coverage)) check [issues][🤝gh-issues] or [PRs][🤝gh-pulls],
|
|
238
|
+
or use the gem and think about how it could be better.
|
|
239
|
+
|
|
240
|
+
We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
|
|
241
|
+
|
|
242
|
+
See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
|
|
243
|
+
|
|
244
|
+
### 🚀 Release Instructions
|
|
245
|
+
|
|
246
|
+
See [CONTRIBUTING.md][🤝contributing].
|
|
247
|
+
|
|
248
|
+
### Code Coverage
|
|
249
|
+
|
|
250
|
+
<details markdown="1">
|
|
251
|
+
<summary>Coverage service badges</summary>
|
|
252
|
+
|
|
253
|
+
[![Coverage Graph][🏀codecov-g]][🏀codecov]
|
|
254
|
+
|
|
255
|
+
[![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
|
|
256
|
+
|
|
257
|
+
[![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
|
|
258
|
+
|
|
259
|
+
</details>
|
|
260
|
+
|
|
261
|
+
### 🪇 Code of Conduct
|
|
262
|
+
|
|
263
|
+
Everyone interacting with this project's codebases, issue trackers,
|
|
264
|
+
chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
|
|
265
|
+
|
|
266
|
+
## 🌈 Contributors
|
|
267
|
+
|
|
268
|
+
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
269
|
+
|
|
270
|
+
Made with [contributors-img][🖐contrib-rocks].
|
|
271
|
+
|
|
272
|
+
Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/yard-timekeeper/-/graphs/main][🚎contributors-gl]
|
|
273
|
+
|
|
274
|
+
<details>
|
|
275
|
+
<summary>⭐️ Star History</summary>
|
|
276
|
+
|
|
277
|
+
<a href="https://star-history.com/galtzo-floss/yard-timekeeper&Date">
|
|
278
|
+
<picture>
|
|
279
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/yard-timekeeper&type=Date&theme=dark" />
|
|
280
|
+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/yard-timekeeper&type=Date" />
|
|
281
|
+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=galtzo-floss/yard-timekeeper&type=Date" />
|
|
282
|
+
</picture>
|
|
283
|
+
</a>
|
|
284
|
+
|
|
285
|
+
</details>
|
|
286
|
+
|
|
287
|
+
## 📌 Versioning
|
|
288
|
+
|
|
289
|
+
This library follows [![Semantic Versioning 2.0.0][📌semver-img]][📌semver] for its public API where practical.
|
|
290
|
+
For most applications, prefer the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
|
291
|
+
|
|
292
|
+
For example:
|
|
293
|
+
|
|
294
|
+
```ruby
|
|
295
|
+
spec.add_dependency("yard-timekeeper", "~> 0.0")
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
<details markdown="1">
|
|
299
|
+
<summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
|
|
300
|
+
|
|
301
|
+
Dropping support for a platform can be a breaking change for affected users.
|
|
302
|
+
If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
|
|
303
|
+
|
|
304
|
+
To get a better understanding of how SemVer is intended to work over a project's lifetime,
|
|
305
|
+
read this article from the creator of SemVer:
|
|
306
|
+
|
|
307
|
+
- ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
|
|
308
|
+
|
|
309
|
+
</details>
|
|
310
|
+
|
|
311
|
+
See [CHANGELOG.md][📌changelog] for a list of releases.
|
|
312
|
+
|
|
313
|
+
## 📄 License
|
|
314
|
+
|
|
315
|
+
The gem is available as open source under the terms of
|
|
316
|
+
the [MIT](MIT.md) [![License: MIT][📄license-img]][📄license-ref].
|
|
317
|
+
|
|
318
|
+
### © Copyright
|
|
319
|
+
|
|
320
|
+
See [LICENSE.md][📄license] for the official copyright notice.
|
|
321
|
+
|
|
322
|
+
<details markdown="1">
|
|
323
|
+
<summary>Copyright holders</summary>
|
|
324
|
+
|
|
325
|
+
- Copyright (c) 2026 Peter H. Boling
|
|
326
|
+
|
|
327
|
+
</details>
|
|
328
|
+
|
|
329
|
+
## 🤑 A request for help
|
|
330
|
+
|
|
331
|
+
Maintainers have teeth and need to pay their dentists.
|
|
332
|
+
After getting laid off in an RIF in March, and encountering difficulty finding a new one,
|
|
333
|
+
I began spending most of my time building open source tools.
|
|
334
|
+
I'm hoping to be able to pay for my kids' health insurance this month,
|
|
335
|
+
so if you value the work I am doing, I need your support.
|
|
336
|
+
Please consider sponsoring me or the project.
|
|
337
|
+
|
|
338
|
+
To join the community or get help 👇️ Join the Discord.
|
|
339
|
+
|
|
340
|
+
[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
341
|
+
|
|
342
|
+
To say "thanks!" ☝️ Join the Discord or 👇️ send money.
|
|
343
|
+
|
|
344
|
+
[![Sponsor galtzo-floss/yard-timekeeper on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
|
|
345
|
+
|
|
346
|
+
### Please give the project a star ⭐ ♥.
|
|
347
|
+
|
|
348
|
+
Thanks for RTFM. ☺️
|
|
349
|
+
|
|
350
|
+
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
351
|
+
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
|
352
|
+
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
353
|
+
[🖇osc-all-img]: https://img.shields.io/opencollective/all/galtzo-floss
|
|
354
|
+
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss
|
|
355
|
+
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/galtzo-floss
|
|
356
|
+
[🖇osc-backers]: https://opencollective.com/galtzo-floss#backer
|
|
357
|
+
[🖇osc-backers-i]: https://opencollective.com/galtzo-floss/backers/badge.svg?style=flat
|
|
358
|
+
[🖇osc-sponsors]: https://opencollective.com/galtzo-floss#sponsor
|
|
359
|
+
[🖇osc-sponsors-i]: https://opencollective.com/galtzo-floss/sponsors/badge.svg?style=flat
|
|
360
|
+
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/galtzo-floss?style=for-the-badge
|
|
361
|
+
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss?style=for-the-badge
|
|
362
|
+
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/galtzo-floss?style=for-the-badge
|
|
363
|
+
[🖇osc]: https://opencollective.com/galtzo-floss
|
|
364
|
+
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
|
365
|
+
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
|
366
|
+
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
367
|
+
[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
|
|
368
|
+
[🖇polar]: https://polar.sh/pboling
|
|
369
|
+
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
|
|
370
|
+
[🖇kofi]: https://ko-fi.com/pboling
|
|
371
|
+
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
|
|
372
|
+
[🖇patreon]: https://patreon.com/galtzo
|
|
373
|
+
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
|
|
374
|
+
[🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
|
|
375
|
+
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
376
|
+
[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
|
|
377
|
+
[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
|
|
378
|
+
[🖇paypal]: https://www.paypal.com/paypalme/peterboling
|
|
379
|
+
[🖇floss-funding.dev]: https://floss-funding.dev
|
|
380
|
+
[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
|
|
381
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
|
382
|
+
[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
|
|
383
|
+
[✉️ruby-friends-img]: https://img.shields.io/badge/daily.dev-%F0%9F%92%8E_Ruby_Friends-0A0A0A?style=for-the-badge&logo=dailydotdev&logoColor=white
|
|
384
|
+
[✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
|
|
385
|
+
|
|
386
|
+
[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
|
|
387
|
+
[⛳️gem-namespace]: https://github.com/galtzo-floss/yard-timekeeper
|
|
388
|
+
[⛳️namespace-img]: https://img.shields.io/badge/namespace-Yard::Timekeeper-3C2D2D.svg?style=square&logo=ruby&logoColor=white
|
|
389
|
+
[⛳️gem-name]: https://bestgems.org/gems/yard-timekeeper
|
|
390
|
+
[⛳️name-img]: https://img.shields.io/badge/name-yard--timekeeper-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
|
|
391
|
+
[⛳️tag-img]: https://img.shields.io/github/tag/galtzo-floss/yard-timekeeper.svg
|
|
392
|
+
[⛳️tag]: https://github.com/galtzo-floss/yard-timekeeper/releases
|
|
393
|
+
[🚂maint-blog]: http://www.railsbling.com/tags/yard-timekeeper
|
|
394
|
+
[🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
|
|
395
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
396
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
|
397
|
+
[💖🖇linkedin]: http://www.linkedin.com/in/peterboling
|
|
398
|
+
[💖🖇linkedin-img]: https://img.shields.io/badge/LinkedIn-Profile-0B66C2?style=flat&logo=newjapanprowrestling
|
|
399
|
+
[💖✌️wellfound]: https://wellfound.com/u/peter-boling
|
|
400
|
+
[💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
|
|
401
|
+
[💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
|
|
402
|
+
[💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
|
|
403
|
+
[💖🐘ruby-mast]: https://ruby.social/@galtzo
|
|
404
|
+
[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
|
|
405
|
+
[💖🦋bluesky]: https://bsky.app/profile/galtzo.com
|
|
406
|
+
[💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
|
|
407
|
+
[💖🌳linktree]: https://linktr.ee/galtzo
|
|
408
|
+
[💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
|
|
409
|
+
[💖💁🏼♂️devto]: https://dev.to/galtzo
|
|
410
|
+
[💖💁🏼♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
|
|
411
|
+
[💖💁🏼♂️aboutme]: https://about.me/peter.boling
|
|
412
|
+
[💖💁🏼♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
|
|
413
|
+
[💖🧊berg]: https://codeberg.org/pboling
|
|
414
|
+
[💖🐙hub]: https://github.org/pboling
|
|
415
|
+
[💖🛖hut]: https://sr.ht/~galtzo/
|
|
416
|
+
[💖🧪lab]: https://gitlab.com/pboling
|
|
417
|
+
[👨🏼🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
|
|
418
|
+
[👨🏼🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
|
|
419
|
+
[👨🏼🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
|
|
420
|
+
[👨🏼🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
|
|
421
|
+
[🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-yard-timekeeper?utm_source=rubygems-yard-timekeeper&utm_medium=referral&utm_campaign=readme
|
|
422
|
+
[🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
|
|
423
|
+
[🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
|
|
424
|
+
[💁🏼♂️peterboling]: http://www.peterboling.com
|
|
425
|
+
[🚂railsbling]: http://www.railsbling.com
|
|
426
|
+
[📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
|
|
427
|
+
[📜src-gl]: https://gitlab.com/galtzo-floss/yard-timekeeper
|
|
428
|
+
[📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
|
|
429
|
+
[📜src-cb]: https://codeberg.org/galtzo-floss/yard-timekeeper
|
|
430
|
+
[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
|
|
431
|
+
[📜src-gh]: https://github.com/galtzo-floss/yard-timekeeper
|
|
432
|
+
[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
433
|
+
[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
434
|
+
[📜gl-wiki]: https://gitlab.com/galtzo-floss/yard-timekeeper/-/wikis/home
|
|
435
|
+
[📜gh-wiki]: https://github.com/galtzo-floss/yard-timekeeper/wiki
|
|
436
|
+
[📜gl-wiki-img]: https://img.shields.io/badge/wiki-gitlab-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
|
|
437
|
+
[📜gh-wiki-img]: https://img.shields.io/badge/wiki-github-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
|
|
438
|
+
[👽dl-rank]: https://bestgems.org/gems/yard-timekeeper
|
|
439
|
+
[👽dl-ranki]: https://img.shields.io/gem/rd/yard-timekeeper.svg
|
|
440
|
+
[👽version]: https://bestgems.org/gems/yard-timekeeper
|
|
441
|
+
[👽versioni]: https://img.shields.io/gem/v/yard-timekeeper.svg
|
|
442
|
+
[🏀qlty-mnt]: https://qlty.sh/gh/galtzo-floss/projects/yard-timekeeper
|
|
443
|
+
[🏀qlty-mnti]: https://qlty.sh/gh/galtzo-floss/projects/yard-timekeeper/maintainability.svg
|
|
444
|
+
[🏀qlty-cov]: https://qlty.sh/gh/galtzo-floss/projects/yard-timekeeper/metrics/code?sort=coverageRating
|
|
445
|
+
[🏀qlty-covi]: https://qlty.sh/gh/galtzo-floss/projects/yard-timekeeper/coverage.svg
|
|
446
|
+
[🏀codecov]: https://codecov.io/gh/galtzo-floss/yard-timekeeper
|
|
447
|
+
[🏀codecovi]: https://codecov.io/gh/galtzo-floss/yard-timekeeper/graph/badge.svg
|
|
448
|
+
[🏀coveralls]: https://coveralls.io/github/galtzo-floss/yard-timekeeper?branch=main
|
|
449
|
+
[🏀coveralls-img]: https://coveralls.io/repos/github/galtzo-floss/yard-timekeeper/badge.svg?branch=main
|
|
450
|
+
[🖐codeQL]: https://github.com/galtzo-floss/yard-timekeeper/security/code-scanning
|
|
451
|
+
[🖐codeQL-img]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/codeql-analysis.yml/badge.svg
|
|
452
|
+
[🚎ruby-3.2-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/ruby-3.2.yml
|
|
453
|
+
[🚎ruby-3.3-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/ruby-3.3.yml
|
|
454
|
+
[🚎ruby-3.4-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/ruby-3.4.yml
|
|
455
|
+
[🚎truby-24.2-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/truffleruby-24.2.yml
|
|
456
|
+
[🚎truby-25.0-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/truffleruby-25.0.yml
|
|
457
|
+
[🚎2-cov-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/coverage.yml
|
|
458
|
+
[🚎2-cov-wfi]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/coverage.yml/badge.svg
|
|
459
|
+
[🚎3-hd-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/heads.yml
|
|
460
|
+
[🚎3-hd-wfi]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/heads.yml/badge.svg
|
|
461
|
+
[🚎5-st-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/style.yml
|
|
462
|
+
[🚎5-st-wfi]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/style.yml/badge.svg
|
|
463
|
+
[🚎9-t-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/truffle.yml
|
|
464
|
+
[🚎9-t-wfi]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/truffle.yml/badge.svg
|
|
465
|
+
[🚎10-j-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/jruby.yml
|
|
466
|
+
[🚎10-j-wfi]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/jruby.yml/badge.svg
|
|
467
|
+
[🚎11-c-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/current.yml
|
|
468
|
+
[🚎11-c-wfi]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/current.yml/badge.svg
|
|
469
|
+
[🚎12-crh-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/dep-heads.yml
|
|
470
|
+
[🚎12-crh-wfi]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/dep-heads.yml/badge.svg
|
|
471
|
+
[🚎13-🔒️-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/locked_deps.yml
|
|
472
|
+
[🚎13-🔒️-wfi]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/locked_deps.yml/badge.svg
|
|
473
|
+
[🚎14-🔓️-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/unlocked_deps.yml
|
|
474
|
+
[🚎14-🔓️-wfi]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/unlocked_deps.yml/badge.svg
|
|
475
|
+
[🚎15-🪪-wf]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/license-eye.yml
|
|
476
|
+
[🚎15-🪪-wfi]: https://github.com/galtzo-floss/yard-timekeeper/actions/workflows/license-eye.yml/badge.svg
|
|
477
|
+
[💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
478
|
+
[💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
479
|
+
[💎ruby-3.4i]: https://img.shields.io/badge/Ruby-3.4-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
480
|
+
[💎ruby-4.0i]: https://img.shields.io/badge/Ruby-4.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
481
|
+
[💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
|
|
482
|
+
[💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
|
|
483
|
+
[💎truby-24.2i]: https://img.shields.io/badge/Truffle_Ruby-24.2-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
|
|
484
|
+
[💎truby-25.0i]: https://img.shields.io/badge/Truffle_Ruby-25.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
|
|
485
|
+
[💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
|
|
486
|
+
[💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
|
|
487
|
+
[💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
|
|
488
|
+
[🤝gh-issues]: https://github.com/galtzo-floss/yard-timekeeper/issues
|
|
489
|
+
[🤝gh-pulls]: https://github.com/galtzo-floss/yard-timekeeper/pulls
|
|
490
|
+
[🤝gl-issues]: https://gitlab.com/galtzo-floss/yard-timekeeper/-/issues
|
|
491
|
+
[🤝gl-pulls]: https://gitlab.com/galtzo-floss/yard-timekeeper/-/merge_requests
|
|
492
|
+
[🤝cb-issues]: https://codeberg.org/galtzo-floss/yard-timekeeper/issues
|
|
493
|
+
[🤝cb-pulls]: https://codeberg.org/galtzo-floss/yard-timekeeper/pulls
|
|
494
|
+
[🤝cb-donate]: https://donate.codeberg.org/
|
|
495
|
+
[🤝contributing]: https://github.com/galtzo-floss/yard-timekeeper/blob/main/CONTRIBUTING.md
|
|
496
|
+
[🏀codecov-g]: https://codecov.io/gh/galtzo-floss/yard-timekeeper/graphs/tree.svg
|
|
497
|
+
[🖐contrib-rocks]: https://contrib.rocks
|
|
498
|
+
[🖐contributors]: https://github.com/galtzo-floss/yard-timekeeper/graphs/contributors
|
|
499
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/yard-timekeeper
|
|
500
|
+
[🚎contributors-gl]: https://gitlab.com/galtzo-floss/yard-timekeeper/-/graphs/main
|
|
501
|
+
[🪇conduct]: https://github.com/galtzo-floss/yard-timekeeper/blob/main/CODE_OF_CONDUCT.md
|
|
502
|
+
[🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
|
|
503
|
+
[📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
|
|
504
|
+
[📌semver]: https://semver.org/spec/v2.0.0.html
|
|
505
|
+
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
|
|
506
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
507
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
508
|
+
[📌changelog]: https://github.com/galtzo-floss/yard-timekeeper/blob/main/CHANGELOG.md
|
|
509
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
510
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
|
|
511
|
+
[📌gitmoji]: https://gitmoji.dev
|
|
512
|
+
[📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
|
|
513
|
+
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
|
|
514
|
+
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.072-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
|
|
515
|
+
[🔐security]: https://github.com/galtzo-floss/yard-timekeeper/blob/main/SECURITY.md
|
|
516
|
+
[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
|
|
517
|
+
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
|
|
518
|
+
[📄license]: LICENSE.md
|
|
519
|
+
[📄license-ref]: MIT.md
|
|
520
|
+
[📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
|
|
521
|
+
[📄license-compat]: https://www.apache.org/legal/resolved.html#category-a
|
|
522
|
+
[📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-✓-259D6C.svg?style=flat&logo=Apache
|
|
523
|
+
[📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
|
|
524
|
+
[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
|
|
525
|
+
[🚎yard-current]: http://rubydoc.info/gems/yard-timekeeper
|
|
526
|
+
[🚎yard-head]: https://yard-timekeeper.galtzo.com
|
|
527
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
528
|
+
[💎SHA_checksums]: https://gitlab.com/galtzo-floss/yard-timekeeper/-/tree/main/checksums
|
|
529
|
+
[💎rlts]: https://github.com/rubocop-lts/rubocop-lts
|
|
530
|
+
[💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
531
|
+
[💎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
532
|
+
[💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
533
|
+
[💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
|
|
534
|
+
|
|
535
|
+
<!-- kettle-jem:metadata:start -->
|
|
536
|
+
| Field | Value |
|
|
537
|
+
|---|---|
|
|
538
|
+
| Package | yard-timekeeper |
|
|
539
|
+
| 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. |
|
|
540
|
+
| Homepage | https://github.com/galtzo-floss/yard-timekeeper |
|
|
541
|
+
| Source | https://github.com/galtzo-floss/yard-timekeeper/tree/v0.1.0 |
|
|
542
|
+
| License | `MIT` |
|
|
543
|
+
| 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 |
|
|
544
|
+
<!-- kettle-jem:metadata:end -->
|
data/RUBOCOP.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# RuboCop Usage Guide
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
A tale of two RuboCop plugin gems.
|
|
6
|
+
|
|
7
|
+
### RuboCop Gradual
|
|
8
|
+
|
|
9
|
+
This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
|
|
10
|
+
|
|
11
|
+
### RuboCop LTS
|
|
12
|
+
|
|
13
|
+
This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
|
|
14
|
+
RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
|
|
15
|
+
|
|
16
|
+
## Checking RuboCop Violations
|
|
17
|
+
|
|
18
|
+
To check for RuboCop violations in this project, always use:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
bundle exec rake rubocop_gradual:check
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
**Do not use** the standard RuboCop commands like:
|
|
25
|
+
- `bundle exec rubocop`
|
|
26
|
+
- `rubocop`
|
|
27
|
+
|
|
28
|
+
## Understanding the Lock File
|
|
29
|
+
|
|
30
|
+
The `.rubocop_gradual.lock` file tracks all current RuboCop violations in the project. This allows the team to:
|
|
31
|
+
|
|
32
|
+
1. Prevent new violations while gradually fixing existing ones
|
|
33
|
+
2. Track progress on code style improvements
|
|
34
|
+
3. Ensure CI builds don't fail due to pre-existing violations
|
|
35
|
+
|
|
36
|
+
## Common Commands
|
|
37
|
+
|
|
38
|
+
- **Check violations**
|
|
39
|
+
- `bundle exec rake rubocop_gradual`
|
|
40
|
+
- `bundle exec rake rubocop_gradual:check`
|
|
41
|
+
- **(Safe) Autocorrect violations, and update lockfile if no new violations**
|
|
42
|
+
- `bundle exec rake rubocop_gradual:autocorrect`
|
|
43
|
+
- **Force update the lock file (w/o autocorrect) to match violations present in code**
|
|
44
|
+
- `bundle exec rake rubocop_gradual:force_update`
|
|
45
|
+
|
|
46
|
+
## Workflow
|
|
47
|
+
|
|
48
|
+
1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
|
|
49
|
+
a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
|
|
50
|
+
2. If there are new violations, either:
|
|
51
|
+
- Fix them in your code
|
|
52
|
+
- Run `bundle exec rake rubocop_gradual:force_update` to update the lock file (only for violations you can't fix immediately)
|
|
53
|
+
3. Commit the updated `.rubocop_gradual.lock` file along with your changes
|
|
54
|
+
|
|
55
|
+
## Never add inline RuboCop disables
|
|
56
|
+
|
|
57
|
+
Do not add inline `rubocop:disable` / `rubocop:enable` comments anywhere in the codebase (including specs, except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). We handle exceptions in two supported ways:
|
|
58
|
+
|
|
59
|
+
- Permanent/structural exceptions: prefer adjusting the RuboCop configuration (e.g., in `.rubocop.yml`) to exclude a rule for a path or file pattern when it makes sense project-wide.
|
|
60
|
+
- Temporary exceptions while improving code: record the current violations in `.rubocop_gradual.lock` via the gradual workflow:
|
|
61
|
+
- `bundle exec rake rubocop_gradual:autocorrect` (preferred; will autocorrect what it can and update the lock only if no new violations were introduced)
|
|
62
|
+
- If needed, `bundle exec rake rubocop_gradual:force_update` (as a last resort when you cannot fix the newly reported violations immediately)
|
|
63
|
+
|
|
64
|
+
In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
|
|
65
|
+
|
|
66
|
+
## Benefits of rubocop_gradual
|
|
67
|
+
|
|
68
|
+
- Allows incremental adoption of code style rules
|
|
69
|
+
- Prevents CI failures due to pre-existing violations
|
|
70
|
+
- Provides a clear record of code style debt
|
|
71
|
+
- Enables focused efforts on improving code quality over time
|
data/SECURITY.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
| Version | Supported |
|
|
6
|
+
|----------|-----------|
|
|
7
|
+
| 1.latest | ✅ |
|
|
8
|
+
|
|
9
|
+
## Security contact information
|
|
10
|
+
|
|
11
|
+
To report a security vulnerability, please use the
|
|
12
|
+
[Tidelift security contact](https://tidelift.com/security).
|
|
13
|
+
Tidelift will coordinate the fix and disclosure.
|
|
14
|
+
|
|
15
|
+
## Additional Support
|
|
16
|
+
|
|
17
|
+
If you are interested in support for versions older than the latest release,
|
|
18
|
+
please consider sponsoring the project / maintainer @ https://liberapay.com/pboling/donate,
|
|
19
|
+
or find other sponsorship links in the [README].
|
|
20
|
+
|
|
21
|
+
[README]: README.md
|